{ "info": { "title": "ATT APIs based on TMF716 - Resource Reservation - MSISDN", "version": "4.0.0", "description": "Number reservation" }, "paths": { "/healthz": { "get": { "summary": "Health Check", "security": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Application up and running", "application_name": "tmf716-resourceReservation-MSISDN" } } }, "description": "Success" } }, "x-page-slug": "716-get-healthz", "description": "Health Check" } }, "/resourceReservation": { "post": { "summary": "createReservation", "responses": { "200": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_MSISDNReservation" } ], "title": "response" }, "examples": { "queryVanityResponse": { "value": { "value": { "@type": "MSISDNReservation", "serviceArea": "123456789012", "relatedParty": [ { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "role": "Commission", "secondaryCode": "GHIJKL" } ], "equipmentType": "G", "reservationItem": [ { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068888080" } }, { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068880101" } } ], "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "billingAccountNumber": "123456789", "subscriberNumberTypeSelector": { "random": { "quantity": 2, "vanityNumber": { "npa": "630", "vanityPattern": "888" } } } }, "description": "API response for above \"queryVanityRequest\"", "displayName": "queryVanityResponse", "operationType": "QUERY" } }, "reserveRandomResponse": { "value": { "value": { "@type": "MSISDNReservation", "serviceArea": "123456789012", "relatedParty": [ { "@type": "Customer", "address": { "AddressLine1": "123 Widget Way", "City": "Springield", "Country": "US", "State": "GA", "Zip": { "zipCode": "29201", "zipCodeExtension": "9375" }, "fieldIndicator": false }, "businessName": "Widgets LLC", "contactName": { "firstName": "Frank", "lastName": "Widget" }, "id": "", "role": "Customer" }, { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "location": "ABC123", "role": "Commission", "salesRepresentative": "Wilson", "secondaryCode": "GHIJKL" } ], "equipmentType": "G", "operationType": "RESERVE", "reservationItem": [ { "@type": "MSISDNReservationItem", "isReserved": true, "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068250210" } }, { "@type": "MSISDNReservationItem", "isReserved": true, "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7063072881" } } ], "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "billingAccountNumber": "123456789", "subscriberNumberTypeSelector": { "random": { "quantity": 2 } } }, "description": "API response for above \"reserveRandomRequest\"", "displayName": "reserveRandomResponse", "operationType": "QUERY" } }, "querySequentialResponse": { "value": { "value": { "@type": "MSISDNReservation", "serviceArea": "123456789012", "relatedParty": [ { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "role": "Commission", "secondaryCode": "GHIJKL" } ], "equipmentType": "G", "operationType": "QUERY", "reservationItem": [ { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7062284400" } }, { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7062284401" } } ], "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "billingAccountNumber": "123456789", "subscriberNumberTypeSelector": { "sequential": { "quantity": 2 } } }, "description": "API response for above \"querySequentialRequest\"", "displayName": "querySequentialResponse", "operationType": "QUERY" } }, "reserveSpecificResponse": { "value": { "value": { "@type": "MSISDNReservation", "serviceArea": "123456789012", "relatedParty": [ { "@type": "Customer", "address": { "AddressLine1": "123 Widget Way", "City": "Springield", "Country": "US", "State": "GA", "Zip": { "zipCode": "29201", "zipCodeExtension": "9375" }, "fieldIndicator": false }, "businessName": "Widgets LLC", "contactName": { "firstName": "Frank", "lastName": "Widget" }, "id": "", "role": "Customer" }, { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "location": "ABC123", "role": "Commission", "salesRepresentative": "Wilson", "secondaryCode": "GHIJKL" } ], "equipmentType": "G", "operationType": "RESERVE", "reservationItem": [ { "@type": "MSISDNReservationItem", "isReserved": true, "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068880101" } } ], "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "billingAccountNumber": "123456789", "subscriberNumberTypeSelector": { "specificNumber": "6308880101" } }, "description": "API response for above \"reserveSpecificRequest\"", "displayName": "reserveSpecificResponse", "operationType": "QUERY" } } } } }, "description": "Success" }, "400": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF716", "message": "JWT Token is required" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" }, "example": { "code": "401", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF716", "message": "Invalid token" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Forbidden" }, "405": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Method Not allowed" }, "409": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Conflict" }, "500": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_error-responses_503" } }, "parameters": [ { "name": "@type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "MSISDN" ] }, "description": "Set qualifier in request" }, { "$ref": "#/components/parameters/trait_error-responses_Authorization" }, { "$ref": "#/components/parameters/trait_headers_Accept" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-CorrelationId" } ], "x-page-slug": "reserve-number", "description": "This operation creates a MSISDNReservation entity. Reserves subscriber numbers. (TMF 716)", "operationId": "createReservation", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_MSISDNReservation_Create" } ], "title": "MSISDNReservation", "description": "The MSISDN Reservation to be created" }, "examples": { "queryVanityRequest": { "value": { "value": { "@type": "MSISDNReservation_Create", "serviceArea": "123456789012", "relatedParty": [ { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "role": "Commission", "secondaryCode": "GHIJKL" } ], "equipmentType": "G", "operationType": "QUERY", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "billingAccountNumber": "123456789", "subscriberNumberTypeSelector": { "random": { "quantity": 2, "vanityNumber": { "npa": "630", "vanityPattern": "888" } } } }, "description": "For a given vanityNumber object, this service provides the capability to request a list of available numbers that can be assigned to the subscriber", "displayName": "queryVanityRequest", "operationType": "QUERY" } }, "reserveRandomRequest": { "value": { "value": { "@type": "MSISDNReservation_Create", "serviceArea": "123456789012", "relatedParty": [ { "@type": "Customer", "address": { "AddressLine1": "123 Widget Way", "City": "Springield", "Country": "US", "State": "GA", "Zip": { "zipCode": "29201", "zipCodeExtension": "9375" }, "fieldIndicator": false }, "businessName": "Widgets LLC", "contactName": { "firstName": "Frank", "lastName": "Widget" }, "id": "", "role": "Customer" }, { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "location": "ABC123", "role": "Commission", "salesRepresentative": "Wilson", "secondaryCode": "GHIJKL" } ], "equipmentType": "G", "operationType": "RESERVE", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "subscriberNumberTypeSelector": { "random": { "quantity": 2 } } }, "description": "This service provides the capability to reserve a block of subscriber numbers for a predetermined time period –30 days for TLG markets (except SAN and HOU TDMA 120 days) & 180 days for CARE markets – from a list of available numbers.", "displayName": "reserveRandomRequest", "operationType": "QUERY" } }, "querySequentialRequest": { "value": { "value": { "@type": "MSISDNReservation_Create", "serviceArea": "123456789012", "relatedParty": [ { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "role": "Commission", "secondaryCode": "GHIJKL" } ], "equipmentType": "G", "operationType": "QUERY", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "billingAccountNumber": "123456789", "subscriberNumberTypeSelector": { "sequential": { "quantity": 2 } } }, "description": "For a given sequential object, this service provides the capability to request a list of available numbers that can be assigned to the subscriber.", "displayName": "querySequentialRequest", "operationType": "QUERY" } }, "reserveSpecificRequest": { "value": { "value": { "@type": "MSISDNReservation_Create", "serviceArea": "123456789012", "relatedParty": [ { "@type": "Customer", "address": { "AddressLine1": "123 Widget Way", "City": "Springield", "Country": "US", "State": "GA", "Zip": { "zipCode": "29201", "zipCodeExtension": "9375" }, "fieldIndicator": false }, "businessName": "Widgets LLC", "contactName": { "firstName": "Frank", "lastName": "Widget" }, "id": "", "role": "Customer" }, { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "location": "ABC123", "role": "Commission", "salesRepresentative": "Wilson", "secondaryCode": "GHIJKL" } ], "equipmentType": "G", "operationType": "RESERVE", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "subscriberNumberTypeSelector": { "specificNumber": "6308880101" } }, "description": "This service provides the capability to reserve a block of subscriber numbers for a predetermined time period –30 days for TLG markets (except SAN and HOU TDMA 120 days) & 180 days for CARE markets – from a list of available numbers.", "displayName": "reserveSpecificRequest", "operationType": "QUERY" } } } } }, "required": true } } }, "/resourceReservation/{id}": { "patch": { "summary": "patchMSISDNReservation", "responses": { "200": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_MSISDNReservation" } ], "title": "response", "description": "This operation partially updates a MSISDNReservation entity. (TMF 716)" }, "examples": { "releaseResponse": { "value": { "value": { "@type": "MSISDNReservation", "operationType": "RELEASE", "reservationItem": [ { "@type": "MSISDNReservationItem", "isReleased": true, "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "5466231488" } } ], "marketServiceInfo": { "billingMarket": "ABC", "billingSubMarket": "DEF" }, "billingAccountNumber": "123456789" }, "description": "API response for above \"releaseRequest\"", "displayName": "releaseResponse", "operationType": "RELEASE" } } } } }, "description": "Updated" }, "400": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Forbidden" }, "404": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Not Found" }, "405": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Method Not allowed" }, "409": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Conflict" }, "500": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" } ], "title": "response" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "@type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "MSISDN" ] }, "description": "Set qualifier in request" } ], "x-page-slug": "release-subscriber-number", "description": "This operation partially updates a MSISDNReservation entity. Releases a subscriber number. (TMF 716)", "operationId": "patchMSISDNReservation", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_MSISDNReservation_Update" } ], "title": "MSISDNReservation", "description": "The ResourceReservation to be updated" }, "examples": { "releaseRequest": { "value": { "value": { "@type": "MSISDNReservation_Update", "operationType": "RELEASE", "reservationItem": [ { "@type": "MSISDNReservationItem", "action": "delete", "resource": { "@type": "MSISDN", "value": "5466231488" } } ], "marketServiceInfo": { "billingMarket": "ABC", "billingSubMarket": "DEF" } }, "description": "This service enables clients to release previously reserved subscriber number. All subscriber numbers must be in a pre-activation/reserved state, or else an error will be returned to the client", "displayName": "releaseRequest", "operationType": "RELEASE" } } } } }, "required": true } }, "parameters": [ { "in": "path", "required": true, "name": "id", "schema": { "type": "string" }, "description": "Identifier of the MSISDNReservation" } ] } }, "openapi": "3.0.3", "security": [ { "ATT-Azure-AD-JWT-Token": [] } ], "components": { "links": {}, "schemas": { "lib_Note": { "type": "object", "properties": { "id": { "type": "string", "title": "id", "description": "Identifier of the note within its containing entity" }, "date": { "type": "string", "title": "date", "format": "date-time", "description": "Date of the note" }, "text": { "type": "string", "title": "text", "description": "Text of the note" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "author": { "type": "string", "title": "author", "description": "Author of the note" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Extra information about a given entity" }, "lib_Place": { "type": "object", "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the place" }, "href": { "type": "string", "title": "href", "description": "Unique reference of the place" }, "name": { "type": "string", "title": "name", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Place reference. Place defines the places where the products are sold or delivered." }, "lib_Error": { "type": "object", "required": [ "code", "reason" ], "properties": { "code": { "type": "string", "title": "code", "description": "Application relevant detail, defined in the API or a common list." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class entity name." }, "reason": { "type": "string", "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user." }, "status": { "type": "string", "title": "status", "description": "HTTP Error code extension" }, "message": { "type": "string", "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class." }, "referenceError": { "type": "string", "title": "referenceError", "description": "URI of documentation describing the error." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)" }, "lib_MSISDN": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_LogicalResource" }, { "type": "object", "properties": { "npaNxx": { "title": "npaNxx", "description": "first 6 digits of subscriber number.", "type": "string", "pattern": "^\\d{6}$" }, "fromLine": { "title": "fromLine", "description": "Last four digits of number, or starting number of number range.", "type": "string", "pattern": "^\\d{4}$" }, "toLine": { "title": "toLine", "description": "Last four digits of ending number of number range.", "type": "string", "pattern": "^\\d{4}$" }, "serviceArea": { "title": "serviceArea", "description": "The service area associated with the subscriber number.", "type": "string", "maxLength": 12 }, "portRequestLineId": { "title": "portRequestLineId", "type": "integer", "format": "int32" }, "equipmentType": { "title": "equipmentType", "description": "Equipment type (Cellular = C, GSM = G)", "type": "string", "enum": [ "C", "G" ] } } } ], "title": "MSISDN" }, "lib_Entity": { "type": "object", "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Base entity schema for use in TMForum Open-APIs" }, "lib_Feature": { "type": "object", "required": [ "name", "featureCharacteristic" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the feature." }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "This is the name for the feature." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "isBundle": { "type": "boolean", "title": "isBundle", "description": "True if this is a feature group. Default is false." }, "isEnabled": { "type": "boolean", "title": "isEnabled", "description": "True if this feature is enabled. Default is true." }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "constraint": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ConstraintRef" }, "title": "constraint", "description": "This is a list of feature constraints." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "featureRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_FeatureRelationship" }, "title": "featureRelationship" }, "featureCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" }, "title": "featureCharacteristic", "minItems": 1, "description": "This is a list of Characteristics for a particular feature.", "uniqueItems": false } }, "description": "Configuration feature." }, "lib_Customer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "businessName": { "title": "businessName", "description": "If this individual is the contact of a business, the name of the business. If this is omitted, individual is not a business contact.", "type": "string" }, "contactName": { "allOf": [ { "$ref": "#/components/schemas/lib_NameInfo" } ], "title": "contactName" }, "address": { "allOf": [ { "$ref": "#/components/schemas/lib_AddressInfo" } ], "description": "Manditory Fields Field Name Case when Mandatory city Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. stateCode Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. zip Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. pob Mandatory only when Address type = 'P.O. Box'. streetName Mandatory only when Address type = 'Street'.", "title": "address" } }, "description": "Customer represents a single human being. The individual can be a customer, or the contact for a business." } ], "title": "Customer" }, "lib_NameInfo": { "type": "object", "required": [ "firstName", "lastName" ], "properties": { "lastName": { "type": "string", "title": "lastName", "description": "Last Name" }, "firstName": { "type": "string", "title": "firstName", "description": "First Name" }, "namePrefix": { "type": "string", "title": "namePrefix", "description": "Name prefix or title (e.g. Dr., Mr., Mrs., etc.)" }, "middleName": { "type": "string", "title": "middleName", "description": "Middle name." }, "nameSuffix": { "type": "string", "title": "nameSuffix", "description": "Name suffix (e.g. Jr. - Junior, Sr. - Senior, etc.)" }, "additionalTitle": { "type": "string", "title": "additionalTitle", "description": "A free text field that holds the additional title of the name (e.g. President, Major, General, etc.)" } } }, "lib_UnitInfo": { "type": "object", "required": [ "unitDesignator", "unitNumber" ], "properties": { "unitNumber": { "type": "string", "title": "unitNumber", "maxLength": 8 }, "unitDesignator": { "type": "string", "enum": [ "APT", "BLDG", "DEPT", "FL", "HNGR", "LOT", "PIER", "RM", "SLIP", "STE", "SPC", "STOP", "TRLR", "UNIT", "BSMT", "FRNT", "OFC", "PH", "REAR", "LOWR", "LBBY", "SIDE", "UPPR", "#" ], "title": "unitDesignator", "description": "APARTMENT -APT, BUILDING -BLDG, DEPARTMENT -DEPT, FLOOR -FL, HANGER -HNGR, LOT -LOT, PIER -PIER, ROOM -RM, SLIP -SLIP, SUITE -STE, STOOP -STOP, TRAILER -TRLR, UNIT -UNIT, BASEMENT -BSMT, FRONT -FRNT, OFFICE -OFC, PENTHOUSE -PH, REAR -REAR, LOWER -LOWR, LOBBY -LBBY, SIDE -SIDE, UPPER-UPPR, SPACE-SPC, #-APT Number" } } }, "lib_Capacity": { "type": "object", "properties": { "place": { "allOf": [ { "$ref": "#/components/schemas/lib_PlaceRefOrValue" } ], "title": "place", "description": "A place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "capacitySpec": { "allOf": [ { "$ref": "#/components/schemas/lib_CapacitySpecRef" } ], "title": "capacitySpec" }, "capacityAmount": { "allOf": [ { "$ref": "#/components/schemas/lib_CapacityAmount" } ], "title": "capacityAmount", "description": "Quantity that defines the Capacity." }, "relatedCapacity": { "type": "array", "items": { "$ref": "#/components/schemas/lib_CapacityRef" }, "title": "relatedCapacity", "description": "related capacity." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "applicableTimePeriod": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ApplicableTimePeriod" }, "title": "applicableTimePeriod", "description": "The period of time for which Capacity or CapacityDemand applies." }, "plannedOrActualCapacity": { "type": "string", "title": "plannedOrActualCapacity", "description": "An indicator that specifies whether the capacity is planned or actual." } }, "description": "Specific ability of an entity measured in quantity and units of quantity over an extended period." }, "lib_PlaceRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered." }, "lib_Quantity": { "type": "object", "properties": { "units": { "type": "string", "title": "units", "description": "Unit" }, "amount": { "type": "number", "title": "amount", "format": "double", "default": 1, "description": "Numeric value in a given unit" } }, "description": "An amount in a given unit" }, "lib_ErrorInfo": { "type": "object", "required": [ "code", "reason", "message", "status" ], "properties": { "code": { "type": "string", "title": "code" }, "reason": { "type": "string", "title": "reason" }, "status": { "type": "string", "title": "status" }, "message": { "type": "string", "title": "message" } }, "description": "The object which holds the response code and description" }, "lib_EntityRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Entity reference schema to be use for all entityRef class." }, "lib_Commission": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "dealerCode": { "title": "dealerCode", "type": "string", "minLength": 0, "maxLength": 6 }, "secondaryCode": { "title": "secondaryCode", "type": "string", "minLength": 0, "maxLength": 6 }, "location": { "title": "location", "type": "string" }, "salesRepresentative": { "title": "salesRepresentative", "type": "string" }, "creditCheckAgent": { "title": "creditCheckAgent", "type": "string" }, "creditCheckAgentLocation": { "title": "creditCheckAgentLocation", "type": "string" }, "affiliateSalesRepCode": { "title": "affiliateSalesRepCode", "type": "string" }, "billingTelephoneNumber": { "title": "billingTelephoneNumber", "type": "string" }, "customerCode": { "title": "customerCode", "type": "string" } }, "description": "A Party object representing the Commission object" } ], "title": "Commission" }, "lib_ChannelRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "Name of the channel." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc.." }, "lib_TimePeriod": { "type": "object", "properties": { "endDateTime": { "type": "string", "title": "endDateTime", "format": "date-time", "example": "1985-04-12T23:20:50.52Z", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "type": "string", "title": "startDateTime", "format": "date-time", "example": "1985-04-12T23:20:50.52Z", "description": "Start of the time period, using IETC-RFC-3339 format" } }, "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "lib_Attachment": { "type": "object", "properties": { "id": { "type": "string", "title": "id", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "Unique identifier for this particular attachment" }, "url": { "type": "string", "title": "url", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "Remote reference to the content if web-addressable" }, "href": { "type": "string", "title": "href", "example": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "URI for this Attachment" }, "name": { "type": "string", "title": "name", "example": "iPhone 14 video", "description": "The name of the attachment" }, "size": { "allOf": [ { "$ref": "#/components/schemas/lib_Quantity" } ], "title": "size", "description": "An amount in a given unit" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "content": { "title": "content", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "mimeType": { "type": "string", "title": "mimeType", "example": "video/mp4", "description": "Attachment mime type such as extension file for video, picture and document" }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "example": "Photograph of the Product", "description": "A narrative text describing the content of the attachment" }, "attachmentType": { "type": "string", "title": "attachmentType", "example": "video", "description": "Attachment type such as video, picture" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Complements the description of an element (for instance a product) through video, pictures..." }, "lib_Extensible": { "type": "object", "properties": { "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Base Extensible schema for use in TMForum Open-APIs" }, "lib_AddressInfo": { "type": "object", "properties": { "Zip": { "allOf": [ { "$ref": "#/components/schemas/lib_AddressZipInfo" } ], "title": "Zip" }, "Unit": { "allOf": [ { "$ref": "#/components/schemas/lib_UnitInfo" } ], "title": "Unit" }, "City": { "type": "string", "title": "City", "maxLength": 40, "description": "The City of this address.Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'." }, "State": { "type": "string", "enum": [ "JA", "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AB", "BC", "DR", "MB", "MX", "NB", "NF", "NS", "ON", "PE", "PQ", "PR", "SK", "VI", "DF", "NA", "GT", "PU", "YA", "SN", "BA", "AP", "CL", "AA", "BI", "PB", "AG", "BN", "CI", "CP", "CS", "DU", "GJ", "GR", "HD", "HK", "MC", "MR", "NL", "NZ", "OX", "QT", "QR", "SL", "SO", "TA", "TB", "TL", "VE", "YC", "ZA", "ZZ", "AE", "BE", "YT", "AS", "FM", "GM", "MH", "NO", "PL", "UM", "VZ", "CE", "CR", "LM", "TE", "FS", "FN", "CN", "GU", "MP", "PW", "NT", "NU", "QC" ], "title": "State", "description": "State abbreviation" }, "Street": { "allOf": [ { "$ref": "#/components/schemas/lib_AddressStreetInfo" } ], "title": "Street" }, "County": { "allOf": [ { "$ref": "#/components/schemas/lib_AddressCountyInfo" } ], "title": "County" }, "Country": { "type": "string", "title": "Country", "pattern": "(([A-Z]{2}|[A-Z]{2})|(([A-Z]{2}|[A-Z]{2})|[A-Z]{2}))", "minLength": 2, "maxLength": 2, "description": "International standard (ISO) 2-character country code." }, "Attention": { "type": "string", "title": "Attention", "maxLength": 25 }, "lastUpdate": { "type": "string", "title": "lastUpdate", "pattern": ".+T.+Z", "description": "Designates a date/time stamp in UTC format. The following formats are accepted: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss.xxxZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - T is a fixed character, indicating the time section - hh indicates the hour, zero pre-pended - mm indicates the minute, zero pre-pended - ss indicates the second, zero pre-pended - xxx indicates the millisecond, zero pre-pended - Z is a fixed character, indicating UTC time zone" }, "RuralRoute": { "allOf": [ { "$ref": "#/components/schemas/lib_AddressRuralRouteInfo" } ], "title": "RuralRoute" }, "addressType": { "type": "string", "enum": [ "S", "M", "P", "R", "F" ], "title": "addressType", "description": "This attribute contains the address type: Street (regular) address=S, Military=M, POB address=P, Rural address=R, Foreign=F" }, "AddressLine1": { "type": "string", "title": "AddressLine1", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "AddressLine2": { "type": "string", "title": "AddressLine2", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "PostOfficeBox": { "type": "string", "title": "PostOfficeBox", "maxLength": 10, "description": "Post Office Box Number." }, "fieldIndicator": { "type": "boolean", "title": "fieldIndicator", "description": "In the request, specifies whether the address validation should take place. If true or not provided, the validation will take place. If false, the validation will be bypassed. In the response, indicates whether the address was reformatted during the validation." }, "addressSubType": { "type": "string", "enum": [ "S", "M", "P", "R", "F" ], "title": "addressSubType", "description": "This attribute contains the address type: Street (regular) address=S, Military=M, POB address=P, Rural address=R, Foreign=F" }, "UrbanizationCode": { "type": "string", "title": "UrbanizationCode", "maxLength": 30, "description": "An urbanization denotes an area, sector, or residential development within a geographic area. In addition to being a descriptive word, it precedes the name of that area. This descriptor, commonly used in Puerto Rican urban areas, is an important part of the addressing format as it describes the location of a given street." }, "internationalZip": { "type": "string", "title": "internationalZip", "description": "This should be populated when the addressSubType is F Foreign\\International" }, "incorporatedIndicator": { "type": "boolean", "title": "incorporatedIndicator", "description": "Incorporated indicator retrieved from Vertex" }, "ruralAddressAttention": { "type": "string", "title": "ruralAddressAttention", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "internationalAddressLine": { "type": "string", "title": "internationalAddressLine", "maxLength": 255, "description": "International address Line 1 of an International address which includes street number, street name, etc. Required if address subtype is 'F'" } }, "description": "Manditory Fields Field Name Case when Mandatory city Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. stateCode Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. zip Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. pob Mandatory only when Address type = 'P.O. Box'. streetName Mandatory only when Address type = 'Street'." }, "lib_CapacityRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Addressable": { "type": "object", "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" } }, "description": "Base schema for adressable entities" }, "lib_ResourceRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_RelatedParty": { "type": "object", "required": [ "id", "@referredType" ], "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "role": { "type": "string", "title": "role", "description": "Role played by the related party" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Related Entity reference. A related party defines party or party role linked to a specific entity." }, "lib_OperationType": { "type": "string", "enum": [ "QUERY", "RESERVE", "RELEASE" ], "title": "operationType", "description": "The QUERY operation type requests up to 5 sequential, random, or vanity subscriber numbers\nand holds the returned number(s) for 24 hours; the RESERVE operation type requests a specfic subscriber\nnumber or up to 5 random or vanity numbers and reserves them for 30 days; the RELEASE operation type\nreleases the reservation of a single number previously reserved using the RESERVE (not QUERY) operation.\nQUERY and RESERVE apply to POST requests only; RELEASE applies to PATCH requests only.\n" }, "lib_RelatedEntity": { "type": "object", "required": [ "id", "role", "@referredType" ], "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "role": { "type": "string", "title": "role", "description": "The role of an entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "A reference to an entity, where the type of the entity is not known in advance." }, "lib_AttachmentRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique-Identifier for this attachment" }, "url": { "type": "string", "title": "url", "description": "Link to the attachment media/content" }, "href": { "type": "string", "title": "href", "description": "URL serving as reference for the attachment resource" }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "A narrative text describing the content of the attachment" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures" }, "lib_ConstraintRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "version": { "type": "string", "title": "version", "description": "constraint version" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec." }, "lib_AddressZipInfo": { "type": "object", "required": [ "zipCode" ], "properties": { "zipCode": { "type": "string", "title": "zipCode", "pattern": "((\\d{5}|\\d{5})|((\\d{5}|\\d{5})|\\d{5}))", "minLength": 5, "maxLength": 5, "description": "Standard Zip Code" }, "zipGeoCode": { "type": "string", "title": "zipGeoCode", "maxLength": 10 }, "zipCodeExtension": { "type": "string", "title": "zipCodeExtension", "pattern": "((\\d{4}|\\d{4})|((\\d{4}|\\d{4})|\\d{4}))", "minLength": 4, "maxLength": 4, "description": "Zip code extension used with Zip+4" } } }, "lib_CapacityAmount": { "type": "object", "properties": { "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "rangeInterval": { "type": "string", "title": "rangeInterval", "description": "An indicator that specifies the inclusion or exclusion of the capacityAmount From and capacityAmountTo attributes. \r\nPossible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." }, "capacityAmount": { "type": "string", "title": "capacityAmount", "description": "A value and units that define the CapacityAmount, such as 10000 ea, 10B Mb. Instance values are mutually exclusive with From and To capacityAmounts and range interval." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "capacityAmountTo": { "type": "string", "title": "capacityAmountTo", "description": "The upper range value that CapacityAmount can take on." }, "capacityAmountFrom": { "type": "string", "title": "capacityAmountFrom", "description": "The low range value that a Capacity Amount can take on." } }, "description": "Quantity that defines the Capacity." }, "lib_Characteristic": { "type": "object", "required": [ "name", "value" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the characteristic" }, "name": { "type": "string", "title": "name", "description": "Name of the characteristic" }, "value": { "title": "value" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "valueType": { "type": "string", "title": "valueType", "description": "Data type of the value of the characteristic" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "characteristicRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_CharacteristicRelationship" }, "title": "characteristicRelationship" } }, "description": "Describes a given characteristic of an object or entity through a name/value pair." }, "lib_RelatedPartyRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of a related party" }, "href": { "type": "string", "title": "href", "description": "Reference of the related party, could be a party reference or a party role reference" }, "name": { "type": "string", "title": "name", "description": "Name of the related party" }, "role": { "type": "string", "title": "role", "description": "Role of the related party." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." }, "lib_ReservationItem": { "type": "object", "properties": { "id": { "type": "string", "title": "id", "description": "A string. Identifier of the item." }, "state": { "type": "string", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "title": "state" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "action": { "type": "string", "enum": [ "add", "modify", "delete", "noChange" ], "title": "action", "description": "action to be performed on the entity" }, "quantity": { "type": "integer", "title": "quantity", "format": "int32" }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedPartyRef" }, "title": "relatedParty" }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedEntity" }, "title": "relatedEntity" }, "capacityDemand": { "allOf": [ { "$ref": "#/components/schemas/lib_Capacity" } ], "title": "capacityDemand", "description": "Specific ability of an entity measured in quantity and units of quantity over an extended period." }, "stateChangeDate": { "type": "string", "title": "stateChangeDate", "format": "date-time", "description": "The date and time the state changed." }, "appliedCapacity": { "allOf": [ { "$ref": "#/components/schemas/lib_Capacity" } ], "title": "appliedCapacity", "description": "Specific ability of an entity measured in quantity and units of quantity over an extended period." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "stateChangeReason": { "type": "string", "title": "stateChangeReason", "description": "The reason for changing the state" }, "reservationPeriod": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "reservationPeriod", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" } }, "description": "An identified part of the reservation. A reservation is decomposed into one or more reservation items." }, "lib_CapacitySpecRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_PlaceRefOrValue": { "type": "object", "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the place" }, "href": { "type": "string", "title": "href", "description": "Unique reference of the place" }, "name": { "type": "string", "title": "name", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "A place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself" }, "lib_LogicalResource": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_Entity" }, { "type": "object", "properties": { "value": { "title": "value", "description": "The value of the logical resource, such as: 0044746712345 for an MSISDN", "type": "string" }, "category": { "title": "category", "description": "Category of the concrete resource, such as: Gold, Silver for MSISDN concrete resource", "type": "string" }, "description": { "title": "description", "description": "Free-text description of the resource", "type": "string" }, "endDate": { "title": "endDate", "description": "The date till the resource is effective", "type": "string", "format": "date-time" }, "lifecycleState": { "title": "lifecycleState", "description": "The life cycle state of the resource", "type": "string" }, "name": { "title": "name", "description": "A string used to give a name to the resource", "type": "string" }, "startDate": { "title": "startDate", "description": "A date time( DateTime). The date from which the resource is effective", "type": "string", "format": "date-time" }, "version": { "title": "version", "description": "A field that identifies the specific version of an instance of a resource", "type": "string" } }, "description": "Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory." } ], "title": "LogicalResource" }, "lib_VanityNumberInfo": { "type": "object", "required": [ "npa" ], "properties": { "npa": { "type": "string", "title": "npa", "pattern": "^\\d{3}$", "description": "Also known as area code; the first 3 digits of the telephone number." }, "vanityPattern": { "type": "string", "title": "vanityPattern", "pattern": "^\\d{3,7}$", "description": "Telephone number pattern for nxx and line number combinations ranging from 3 to 7 digits." } } }, "lib_ReasonDetailInfo": { "type": "object", "required": [ "code", "description" ], "properties": { "code": { "type": "string", "title": "code" }, "severity": { "type": "string", "enum": [ "Recoverable", "UnRecoverable" ], "title": "severity" }, "description": { "type": "string", "title": "description" }, "origination": { "type": "string", "title": "origination" } } }, "lib_MSISDNReservation": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ResourceReservation" }, { "type": "object", "properties": { "operationType": { "allOf": [ { "$ref": "#/components/schemas/lib_OperationType" } ], "description": "Selects the reservation operation performed", "title": "operationType" }, "subscriberNumberTypeSelector": { "allOf": [ { "$ref": "#/components/schemas/lib_SubscriberNumberTypeSelector" } ], "title": "subscriberNumberTypeSelector" }, "equipmentType": { "title": "equipmentType", "description": "Equipment type (Cellular = C, GSM = G)", "type": "string", "enum": [ "C", "G" ] }, "serviceArea": { "title": "serviceArea", "description": "The service area associated with this subscriber number.", "type": "string" }, "marketServiceInfo": { "allOf": [ { "$ref": "#/components/schemas/lib_MarketServiceInfo" } ], "title": "marketServiceInfo" }, "billingAccountNumber": { "title": "billingAccountNumber", "description": "The billingAccountNumber is only optional for Reseller partners. All other partners are required to send a billingAccountNumber.", "type": "string" }, "storeId": { "title": "storeId", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "type": "string" }, "subscriptionClass": { "title": "subscriptionClass", "description": "Describes the class or category of subscriber. This element is required for OnStar reservations. Possible values S for GM and U for Audi", "type": "string" }, "commonOrderId": { "title": "commonOrderId", "description": "Id associated with direct fulfillment", "type": "string" } }, "required": [ "operationType" ] } ], "title": "MSISDNReservation" }, "lib_MarketServiceInfo": { "type": "object", "properties": { "localMarket": { "type": "string", "title": "localMarket", "minLength": 4, "maxLength": 4 }, "productType": { "type": "string", "enum": [ "C", "G" ], "title": "productType", "description": "Equipment type (Cellular = C, GSM = G)" }, "billingMarket": { "type": "string", "title": "billingMarket", "minLength": 3, "maxLength": 3 }, "serviceZipCode": { "type": "string", "title": "serviceZipCode", "pattern": "^\\d{5}$", "description": "Service area zip code for primary subscriber - sets the service market/submarket.." }, "billingSystemId": { "type": "string", "title": "billingSystemId", "maxLength": 12, "description": "The service area associated with the subscriber number." }, "billingSubMarket": { "type": "string", "title": "billingSubMarket", "minLength": 1, "maxLength": 3 } } }, "lib_AddressCountyInfo": { "type": "object", "properties": { "countyType": { "type": "string", "title": "countyType", "maxLength": 1 }, "countyName": { "type": "string", "title": "countyName", "maxLength": 3 } } }, "lib_AddressStreetInfo": { "type": "object", "required": [ "streetNumber", "streetName" ], "properties": { "streetType": { "type": "string", "enum": [ "ALY", "ANX", "ARC", "AVE", "BCH", "BG", "BGS", "BLF", "BLFS", "BLVD", "BND", "BR", "BRG", "BRK", "BRKS", "BTM", "BYP", "BYU", "CIR", "CIRS", "CLB", "CLF", "CLFS", "CMN", "COR", "CORS", "CP", "CPE", "CRES", "CRK", "CRSE", "CRST", "CSWY", "CT", "CTR", "CTRS", "CTS", "CURV", "CV", "CVS", "CYN", "DL", "DM", "DR", "DRS", "DV", "EST", "ESTS", "EXPY", "EXT", "EXTS", "FALL", "FLD", "FLDS", "FLS", "FLT", "FLTS", "FRD", "FRDS", "FRG", "FRGS", "FRK", "FRKS", "FRST", "FRY", "FT", "FWY", "GDN", "GDNS", "GLN", "GLNS", "GRN", "GRNS", "GRV", "GRVS", "GTWY", "HBR", "HBRS", "HCR", "HL", "HLS", "HOLW", "HTS", "HVN", "HWY", "INLT", "INST", "IS", "ISLE", "ISS", "JCT", "JCTS", "KNL", "KNLS", "KY", "KYS", "LAND", "LCK", "LCKS", "LDG", "LF", "LGT", "LGTS", "LK", "LKS", "LN", "LNDG", "LOOP", "MALL", "MDW", "MDWS", "MEWS", "ML", "MLS", "MNR", "MNRS", "MSN", "MT", "MTN", "MTNS", "MTWY", "NCK", "OPAS", "ORCH", "OVAL", "PARK", "PASS", "PATH", "PIKE", "PKWY", "PL", "PLN", "PLNS", "PLZ", "PNE", "PNES", "PR", "PRT", "PRTS", "PSGE", "PT", "PTS", "RADL", "RAMP", "RD", "RDG", "RDGS", "RDS", "RIV", "RNCH", "ROW", "RPD", "RPDS", "RST", "RTE", "RUE", "RUN", "SHL", "SHLS", "SHR", "SHRS", "SKWY", "SMT", "SPG", "SPGS", "SPUR", "SQ", "SQS", "ST", "STA", "STRA", "STRM", "STS", "TER", "TPKE", "TRAK", "TRCE", "TRFY", "TRL", "TRLR", "TRWY", "TUNL", "UN", "UNS", "UPAS", "VIA", "VIS", "VL", "VLG", "VLGS", "VLY", "VLYS", "VW", "VWS", "WALK", "WALL", "WAY", "WAYS", "WL", "WLS", "XING", "XRD" ], "title": "streetType", "description": "The street type, e.g., Street, Avenue, Grove, etc. to be checked against a decoding table: ALLEY=ALY,ANNEX=ANX,ARCADE=ARC,AVENUE=AVE,BAYOU=BYU,BEACH=BCH,BEND=BND,BLUFF=BLF,BLUFFS=BLFS, BOTTOM=BTM,BOULEVARD=BLVD,BRANCH=BR,BRIDGE=BRG,BROOK=BRK,BROOKS=BRKS,BURG=BG,BURGS=BGS, BYPASS=BYP,CAMP=CP,CANYON=CYN,CAPE=CPE,CAUSEWAY=CSWY,CENTER=CTR,CENTERS=CTRS,CIRCLE=CIR, CIRCLES=CIRS,CLIFF=CLF,CLIFFS=CLFS,CLUB=CLB,COMMON=CMN,CORNER=COR,CORNERS=CORS,COURSE=CRSE, COURT=CT,COURTS=CTS,COVE=CV,COVES=CVS,CREEK=CRK,CRESENT=CRES,CREST=CRST,CROSSING=XING, CROSSROAD=XRD,CURVE=CURV,DALE=DL,DAM=DM,DIVIDE=DV,DRIVE=DR,DRIVES=DRS,ESTATE=EST,ESTATES=ESTS ,EXPRESSWAY=EXPY,EXTENSION=EXT,EXTENSIONS=EXTS,FALL=FALL,FALLS=FLS,FERRY=FRY,FIELD=FLD,FIELDS=FLDS, FLAT=FLT,FLATS=FLTS,FORD=FRD,FORDS=FRDS,FOREST=FRST,FORGE=FRG,FORGES=FRGS,FORK=FRK,FORKS=FRKS, FORT=FT,FREEWAY=FWY,GARDEN=GDN,GARDENS=GDNS,GARDENS=GDNS,GATEWAY=GTWY,GLEN=GLN,GLENS=GLNS, GREEN=GRN,GREENS=GRNS,GROVE=GRV,GROVES=GRVS,HARBOR=HBR,HARBORS=HBRS,HAVEN=HVN,HEIGHTS=HTS, HIGHWAY=HWY,HILL=HL,HILLS=HLS,HOLLOW=HOLW,INLET=INLT,ISLAND=IS,ISLANDS=ISS,ISLE=ISLE,JUNCTION=JCT, JUNCTIONS=JCTS,KEY=KY,KEYS=KYS,KNOLL=KNL,KNOLLS=KNLS,LAKE=LK,LAKES=LKS,LAND=LAND,LANDING=LNDG, LANE=LN,LIGHT=LGT,LIGHTS=LGTS,LOAF=LF,LOCK=LCK,LOCKS=LCKS,LODGE=LDG,LOOP=LOOP,MALL=MALL,MANOR=MNR, MANORS=MNRS,MEADOW=MDW,MEADOWS=MDWS,MEWS=MEWS,MILL=ML,MILLS=MLS,MISSION=MSN,MOTORWAY=MTWY, MOUNT=MT,MOUNT=MT,MOUNTAIN=MTN,MOUNTAINS=MTNS,NECK=NCK,ORCHARD=ORCH,OVAL=OVAL,OVERPASS=OPAS, PARK=PARK,PARKWAY=PKWY,PARKWAY=PKWY,PARKWAYS=PKWY,PASS=PASS,PASSAGE=PSGE,PATH=PATH,PIKE=PIKE, PINE=PNE,PINES=PNES,PLACE=PL,PLAIN=PLN,PLAINS=PLNS,PLAZA=PLZ,POINT=PT,POINTS=PTS,PORT=PRT,PORTS=PRTS, PRAIRIE=PR,RADIAL=RADL,RAMP=RAMP,RANCH=RNCH,RAPID=RPD,RAPIDS=RPDS,REST=RST,RIDGE=RDG,RIDGES=RDGS, RIVER=RIV,ROAD=RD,ROADS=RDS,ROUTE=RTE,ROW=ROW,RUE=RUE,RUN=RUN,SHOAL=SHL,SHOALS=SHLS,SHORE=SHR, SHORES=SHRS,SKYWAY=SKWY,SPRING=SPG,SPRINGS=SPGS,SPUR=SPUR,SQUARE=SQ,SQUARES=SQS,STATION=STA, STRAVENUE=STRA,STREAM=STRM,STREET=ST,STREETS=STS,SUMMIT=SMT,TERRACE=TER,THROUGHWAY=TRWY, THRUWAY=TRWY,TRACE=TRCE,TRACK=TRAK,TRAFFICWAY=TRFY,TRAIL=TRL,TUNNEL=TUNL,TURNPIKE=TPKE, UNDERPASS=UPAS,UNION=UN,UNIONS=UNS,VALLEY=VLY,VALLEYS=VLYS,VIADUCT=VIA,VIEW=VW,VIEWS=VWS, VILLAGE=VLG,VILLAGES=VLGS,VILLE=VL,VISTA=VIS,WALK=WALK,WALL=WALL,WAY=WAY,WAYS=WAYS,WELL=WL, WELLS=WLS" }, "streetName": { "type": "string", "title": "streetName", "maxLength": 50 }, "streetNumber": { "type": "string", "title": "streetNumber", "maxLength": 10, "description": "The address house number number." }, "streetDirection": { "type": "string", "enum": [ "E", "N", "NE", "NW", "S", "SE", "SW", "W" ], "title": "streetDirection", "description": "The address street direction (east, west. etc.): EAST=E, NORTH=N, NORTH EAST=NE, NORTH WEST=NW, SOUTH=S, SOUTH EAST= SE, SOUTH WEST=SW, WEST=W." }, "streetTrailingDirection": { "type": "string", "enum": [ "E", "N", "NE", "W", "NW", "S", "SE", "SW" ], "title": "streetTrailingDirection", "description": "The address trailing street direction (east, west. etc.). East - E, North - N, North East - NE, North West - NW, South - S, South East - SE, South West - SW, West - W" } } }, "lib_ResourceRefOrValue": { "type": "object", "required": [ "id", "href" ], "properties": { "id": { "type": "string", "title": "id", "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." }, "href": { "type": "string", "title": "href", "description": "The URI for the object itself." }, "name": { "type": "string", "title": "name", "description": "A string used to give a name to the resource" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" }, "title": "note" }, "place": { "allOf": [ { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" } ], "title": "place", "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "category": { "type": "string", "title": "category", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/lib_AttachmentRefOrValue" }, "title": "attachment" }, "usageState": { "type": "string", "enum": [ "idle", "active", "busy" ], "title": "usageState", "description": "ResourceUsageStateType enumerations" }, "description": { "type": "string", "title": "description", "description": "free-text description of the resource" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" }, "title": "relatedParty" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "resourceStatus": { "type": "string", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ], "title": "resourceStatus", "description": "ResourceStatusType enumerations" }, "resourceVersion": { "type": "string", "title": "resourceVersion", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "title": "endOperatingDate", "format": "date-time", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "type": "string", "enum": [ "enable", "disable" ], "title": "operationalState", "description": "ResourceOperationalStateType enumerations" }, "activationFeature": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Feature" }, "title": "activationFeature", "description": "Configuration features" }, "startOperatingDate": { "type": "string", "title": "startOperatingDate", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ], "title": "administrativeState", "description": "ResourceAdministrativeStateType enumerations" }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResourceRelationship" }, "title": "resourceRelationship" }, "resourceSpecification": { "allOf": [ { "$ref": "#/components/schemas/lib_ResourceSpecificationRef" } ], "title": "resourceSpecification", "description": "Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components.\n\nA ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.\n" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" }, "title": "resourceCharacteristic" } }, "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Resource entity and not the related ResourceRefOrValue class itself" }, "lib_ResourceReservation": { "type": "object", "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "state": { "type": "string", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "title": "state" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "channel": { "allOf": [ { "$ref": "#/components/schemas/lib_ChannelRef" } ], "title": "channel", "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc.." }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "A string. free-text description of the reservation." }, "creationDate": { "type": "string", "title": "creationDate", "format": "date-time", "description": "Date when the reservation was created" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedPartyRef" }, "title": "relatedParty" }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedEntity" }, "title": "relatedEntity" }, "completionDate": { "type": "string", "title": "completionDate", "description": "Date when the reservation was completed" }, "stateChangeDate": { "type": "string", "title": "stateChangeDate", "format": "date-time", "description": "The date and time the state changed." }, "reservationItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ReservationItem" }, "title": "reservationItem" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "cancellationDate": { "type": "string", "title": "cancellationDate", "description": "Date when the reservation is cancelled." }, "stateChangeReason": { "type": "string", "title": "stateChangeReason", "description": "The reason for changing the state" }, "reservationPeriod": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "reservationPeriod", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "cancellationReason": { "type": "string", "title": "cancellationReason", "description": "Reason why the reservation is cancelled." }, "requestedStartDate": { "type": "string", "title": "requestedStartDate", "description": "Reservation fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow the reservation to begin before a specific date." }, "expectedCompletionDate": { "type": "string", "title": "expectedCompletionDate", "description": "Expected completion date amended by the provider" }, "requestedCompletionDate": { "type": "string", "title": "requestedCompletionDate", "description": "Requested completion date from the requestor perspective" } } }, "lib_FeatureRelationship": { "type": "object", "required": [ "name", "relationshipType" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the target feature." }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "This is the name of the target feature." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "relationshipType": { "type": "string", "title": "relationshipType", "description": "This is the type of the feature relationship." } }, "description": "Configuration feature" }, "lib_ApplicableTimePeriod": { "type": "object", "properties": { "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "dayOfWeek": { "type": "string", "title": "dayOfWeek", "description": "A day or days representing when the schedule is applicable. For example 2, 3 represent Monday and Tuesday." }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "rangeInterval": { "type": "string", "title": "rangeInterval", "description": "An indicator that specifies the inclusion or exclusion of the from and to DateTime attributes. \r\nPossible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." }, "fromToDateTime": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "fromToDateTime", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "The period of time for which Capacity or CapacityDemand applies." }, "lib_AttachmentRefOrValue": { "type": "object", "properties": { "id": { "type": "string", "title": "id", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "Unique identifier for this particular attachment" }, "url": { "type": "string", "title": "url", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "Remote reference to the content if web-addressable" }, "href": { "type": "string", "title": "href", "example": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "URI for this Attachment" }, "name": { "type": "string", "title": "name", "example": "iPhone 14 video", "description": "The name of the attachment" }, "size": { "allOf": [ { "$ref": "#/components/schemas/lib_Quantity" } ], "title": "size", "description": "An amount in a given unit" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "content": { "title": "content", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "mimeType": { "type": "string", "title": "mimeType", "example": "video/mp4", "description": "Attachment mime type such as extension file for video, picture and document" }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "example": "Photograph of the Product", "description": "A narrative text describing the content of the attachment" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "attachmentType": { "type": "string", "title": "attachmentType", "example": "video", "description": "Attachment type such as video, picture" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture." }, "lib_ResourceRelationship": { "type": "object", "required": [ "relationshipType", "resource" ], "properties": { "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "resource": { "allOf": [ { "$ref": "#/components/schemas/lib_ResourceRefOrValue" } ], "title": "resource", "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Resource entity and not the related ResourceRefOrValue class itself" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "relationshipType": { "type": "string", "title": "relationshipType", "example": "bundled", "description": "Type of the resource relationship, such as [bundled] if the resource is a bundle and you want to describe the bundled resources inside this bundle; [reliesOn] if the resource needs another already owned resource to rely on (eg: an option on an already owned mobile access resource) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" } }, "description": "Linked resources to the one instantiate, such as [bundled] if the resource is a bundle and you want to describe the bundled resources inside this bundle; [reliesOn] if the resource needs another already owned resource to rely on (e.g. an option on an already owned mobile access resource) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" }, "lib_MSISDNReservationItem": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ReservationItem" }, { "type": "object", "properties": { "msisdn": { "allOf": [ { "$ref": "#/components/schemas/lib_MSISDN" } ], "title": "msisdn" }, "depositAmount": { "title": "depositAmount", "type": "string" }, "msid": { "title": "msid", "type": "string" }, "isReserved": { "title": "isReserved", "description": "Indicates the MSISDN was successfully reserved", "type": "boolean" }, "isReleased": { "title": "isReleased", "description": "Indicates the MSISDN was successfully released", "type": "boolean" }, "error": { "allOf": [ { "$ref": "#/components/schemas/lib_ErrorInfo" } ], "title": "error" } }, "description": "A reserved MSISDN with associated information" } ], "title": "MSISDNReservationItem" }, "lib_AddressRuralRouteInfo": { "type": "object", "required": [ "ruralRouteBoxNumber", "ruralRouteCenterNumber" ], "properties": { "ruralRouteBoxNumber": { "type": "string", "title": "ruralRouteBoxNumber", "maxLength": 10 }, "ruralRouteCenterNumber": { "type": "string", "title": "ruralRouteCenterNumber", "maxLength": 6 } } }, "lib_RandomSubscriberNumber": { "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "type": "integer", "title": "quantity", "format": "int32", "minimum": 1, "maximum": 5, "description": "The quantity of subscriber numbers to reserve (1-5)" }, "vanityNumber": { "allOf": [ { "$ref": "#/components/schemas/lib_VanityNumberInfo" } ], "title": "vanityNumber" } } }, "lib_RelatedPlaceRefOrValue": { "type": "object", "required": [ "role" ], "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the place" }, "href": { "type": "string", "title": "href", "description": "Unique reference of the place" }, "name": { "type": "string", "title": "name", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "role": { "type": "string", "title": "role" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself" }, "lib_ResourceReservationRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_MSISDNReservation_Create": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ResourceReservation_Create" }, { "type": "object", "properties": { "operationType": { "allOf": [ { "$ref": "#/components/schemas/lib_OperationType" } ], "description": "Selects the reservation operation to be performed", "title": "operationType" }, "subscriberNumberTypeSelector": { "allOf": [ { "$ref": "#/components/schemas/lib_SubscriberNumberTypeSelector" } ], "title": "subscriberNumberTypeSelector" }, "equipmentType": { "title": "equipmentType", "description": "Equipment type (Cellular = C, GSM = G)", "type": "string", "enum": [ "C", "G" ] }, "serviceArea": { "title": "serviceArea", "description": "The service area associated with this subscriber number.", "type": "string", "maxLength": 12 }, "marketServiceInfo": { "allOf": [ { "$ref": "#/components/schemas/lib_MarketServiceInfo" } ], "title": "marketServiceInfo" }, "billingAccountNumber": { "title": "billingAccountNumber", "description": "The billingAccountNumber is only optional for Reseller partners. All other partners are required to send a billingAccountNumber.", "type": "string" }, "storeId": { "title": "storeId", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "type": "string" }, "subscriptionClass": { "title": "subscriptionClass", "description": "Describes the class or category of subscriber. This element is required for OnStar reservations. Possible values S for GM and U for Audi", "type": "string" }, "commonOrderId": { "title": "commonOrderId", "description": "Id associated with direct fulfillment", "type": "string" } }, "required": [ "operationType" ] } ], "title": "MSISDNReservation_Create" }, "lib_MSISDNReservation_Update": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ResourceReservation_Update" }, { "type": "object", "properties": { "operationType": { "allOf": [ { "$ref": "#/components/schemas/lib_OperationType" } ], "description": "Selects the reservation operation to be performed", "title": "operationType" }, "subscriberNumberTypeSelector": { "allOf": [ { "$ref": "#/components/schemas/lib_SubscriberNumberTypeSelector" } ], "title": "subscriberNumberTypeSelector" }, "equipmentType": { "title": "equipmentType", "description": "Equipment type (Cellular = C, GSM = G)", "type": "string", "enum": [ "C", "G" ] }, "serviceArea": { "title": "serviceArea", "description": "The service area associated with this subscriber number.", "type": "string" }, "marketServiceInfo": { "allOf": [ { "$ref": "#/components/schemas/lib_MarketServiceInfo" } ], "title": "marketServiceInfo" }, "billingAccountNumber": { "title": "billingAccountNumber", "description": "The billingAccountNumber is only optional for Reseller partners. All other partners are required to send a billingAccountNumber.", "type": "string" }, "storeId": { "title": "storeId", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "type": "string" }, "subscriptionClass": { "title": "subscriptionClass", "description": "Describes the class or category of subscriber. This element is required for OnStar reservations. Possible values S for GM and U for Audi", "type": "string" }, "commonOrderId": { "title": "commonOrderId", "description": "Id associated with direct fulfillment", "type": "string" } }, "required": [ "operationType" ] } ], "title": "MSISDNReservation_Update" }, "lib_InternationalAddressInfo": { "type": "object", "properties": { "zone": { "type": "string", "title": "zone", "maxLength": 50 }, "city": { "type": "string", "title": "city", "maxLength": 40, "description": "The City of this address.Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'." }, "region": { "type": "string", "title": "region", "maxLength": 50, "description": "Typically value for state but different for other countries. For Canada: province." }, "country": { "type": "string", "title": "country", "maxLength": 50, "description": "iso2, iso3, or country name" }, "placeName": { "type": "string", "title": "placeName", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "subregion": { "type": "string", "title": "subregion", "maxLength": 50, "description": "For USA = county" }, "postalCode": { "type": "string", "title": "postalCode", "maxLength": 12, "description": "International postal code" }, "neighborhood": { "type": "string", "title": "neighborhood", "maxLength": 50, "description": "For example, in Mexico: colonia." }, "singleLineAddress": { "type": "string", "title": "singleLineAddress", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "streetAddressLine2": { "type": "string", "title": "streetAddressLine2", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "streetAddressLine1": { "type": "string", "title": "streetAddressLine1", "maxLength": 120, "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here." }, "postalCodeExtension": { "type": "string", "title": "postalCodeExtension", "maxLength": 12 } }, "description": "Facilitates Worldwide Address Validation (US, Canada, Mexico, and more)" }, "lib_ResourceSpecificationRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "id", "description": "unique identifier" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "name": { "type": "string", "title": "name", "description": "Name of the related entity." }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "version": { "type": "string", "title": "version", "description": "Resource Specification version" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components.\n\nA ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.\n" }, "lib_SequentialSubscriberNumber": { "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "type": "integer", "title": "quantity", "format": "int32", "minimum": 1, "maximum": 5, "description": "The quantity of subscriber numbers to reserve (1-5)" } } }, "lib_ResourceReservation_Create": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "title": "state" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "channel": { "allOf": [ { "$ref": "#/components/schemas/lib_ChannelRef" } ], "title": "channel", "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc.." }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "A string. free-text description of the reservation." }, "creationDate": { "type": "string", "title": "creationDate", "format": "date-time", "description": "Date when the reservation was created" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedPartyRef" }, "title": "relatedParty" }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedEntity" }, "title": "relatedEntity" }, "completionDate": { "type": "string", "title": "completionDate", "description": "Date when the reservation was completed" }, "stateChangeDate": { "type": "string", "title": "stateChangeDate", "format": "date-time", "description": "The date and time the state changed." }, "reservationItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ReservationItem" }, "title": "reservationItem" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "cancellationDate": { "type": "string", "title": "cancellationDate", "description": "Date when the reservation is cancelled." }, "stateChangeReason": { "type": "string", "title": "stateChangeReason", "description": "The reason for changing the state" }, "reservationPeriod": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "reservationPeriod", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "cancellationReason": { "type": "string", "title": "cancellationReason", "description": "Reason why the reservation is cancelled." }, "requestedStartDate": { "type": "string", "title": "requestedStartDate", "description": "Reservation fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow the reservation to begin before a specific date." }, "expectedCompletionDate": { "type": "string", "title": "expectedCompletionDate", "description": "Expected completion date amended by the provider" }, "requestedCompletionDate": { "type": "string", "title": "requestedCompletionDate", "description": "Requested completion date from the requestor perspective" } }, "description": "Skipped properties: id,href" }, "lib_ResourceReservation_Update": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "title": "state" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "channel": { "allOf": [ { "$ref": "#/components/schemas/lib_ChannelRef" } ], "title": "channel", "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc.." }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "title": "description", "description": "A string. free-text description of the reservation." }, "creationDate": { "type": "string", "title": "creationDate", "format": "date-time", "description": "Date when the reservation was created" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedPartyRef" }, "title": "relatedParty" }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedEntity" }, "title": "relatedEntity" }, "completionDate": { "type": "string", "title": "completionDate", "description": "Date when the reservation was completed" }, "stateChangeDate": { "type": "string", "title": "stateChangeDate", "format": "date-time", "description": "The date and time the state changed." }, "reservationItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ReservationItem" }, "title": "reservationItem" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "cancellationDate": { "type": "string", "title": "cancellationDate", "description": "Date when the reservation is cancelled." }, "stateChangeReason": { "type": "string", "title": "stateChangeReason", "description": "The reason for changing the state" }, "reservationPeriod": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" } ], "title": "reservationPeriod", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "cancellationReason": { "type": "string", "title": "cancellationReason", "description": "Reason why the reservation is cancelled." }, "requestedStartDate": { "type": "string", "title": "requestedStartDate", "description": "Reservation fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow the reservation to begin before a specific date." }, "expectedCompletionDate": { "type": "string", "title": "expectedCompletionDate", "description": "Expected completion date amended by the provider" }, "requestedCompletionDate": { "type": "string", "title": "requestedCompletionDate", "description": "Requested completion date from the requestor perspective" } }, "description": "Skipped properties: id,href" }, "lib_CharacteristicRelationship": { "type": "object", "properties": { "id": { "type": "string", "title": "id", "description": "Unique identifier of the characteristic" }, "href": { "type": "string", "title": "href", "description": "Hyperlink reference" }, "@type": { "type": "string", "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "title": "@baseType", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "relationshipType": { "type": "string", "title": "relationshipType", "description": "The type of relationship" } }, "description": "Another Characteristic that is related to the current Characteristic." }, "lib_SubscriberNumberTypeSelector": { "type": "object", "properties": { "random": { "allOf": [ { "$ref": "#/components/schemas/lib_RandomSubscriberNumber" } ], "title": "random" }, "sequential": { "allOf": [ { "$ref": "#/components/schemas/lib_SequentialSubscriberNumber" } ], "title": "sequential" }, "specificNumber": { "type": "string", "title": "subscriberNumber", "pattern": "^\\d{10}$", "description": "The subscriber number being reserved." } } } }, "headers": {}, "examples": {}, "responses": { "trait_jwt_400": { "content": { "application/json": { "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF716", "message": "JWT Token is required" } } }, "description": "JWT Token is required." }, "trait_jwt_401": { "content": { "application/json": { "example": { "code": "401", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF716", "message": "Invalid token" } } }, "description": "Invalid token." }, "trait_jwt_503": { "content": { "application/json": { "example": { "code": "503", "reason": "Internal Server Error", "status": "503-INTERNAL SERVER_ERROR-TMF716", "message": "Internal Server Error" } } }, "description": "Error communicating with JWKS server." }, "trait_error-responses_400": { "content": { "application/json": { "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF716", "message": "JWT Token is required" } } }, "description": "JWT Token is required." }, "trait_error-responses_401": { "content": { "application/json": { "example": { "code": "401", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF716", "message": "Invalid token" } } }, "description": "Invalid token." }, "trait_error-responses_503": { "content": { "application/json": { "example": { "code": "503", "reason": "Internal Server Error", "status": "503-INTERNAL SERVER_ERROR-TMF716", "message": "Internal Server Error" } } }, "description": "Error communicating with JWKS server." }, "securityScheme_ATT_Azure_AD_JWT_Token_200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "token_type", "expires_in", "ext_expires_in", "access_token" ], "properties": { "token_type": { "type": "string", "example": "Bearer", "default": "Bearer" }, "expires_in": { "type": "integer", "format": "int32", "example": 3599 }, "access_token": { "type": "string", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, "ext_expires_in": { "type": "integer", "format": "int32", "example": 3599 } }, "description": "Dummy token below. Real token is much longer with more relevant info" } } }, "description": "No description provided" }, "securityScheme_ATT_Azure_AD_JWT_Token_400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "error_description", "error_codes", "timestamp", "trace_id", "correlation_id", "error_uri" ], "properties": { "error": { "type": "string", "example": "unauthorized_client" }, "trace_id": { "type": "string", "example": "b82bea2f-5ee3-48a4-9774-4143176a6900" }, "timestamp": { "type": "string", "example": "2021-06-30 21:12:34Z" }, "error_uri": { "type": "string", "example": "https://login.microsoftonline.com/error?code=700016" }, "error_codes": { "type": "array", "items": { "type": "integer", "format": "int32", "example": 700016 } }, "correlation_id": { "type": "string", "example": "b57403ef-e775-49f6-b40f-009ba759c301" }, "error_description": { "type": "string", "example": "AADSTS700016: Application with identifier '6bb2748d-d916-4534-9145-ee8f598d2e01' was not found in the directory 'e741d71c-c6b6-47b0-803c-0f3b32b07556'. This can happen if the application has not been installed by the administrator of the tenant or consented to by any user in the tenant. You may have sent your authentication request to the wrong tenant.\\r\\nTrace ID: b82bea2f-5ee3-48a4-9774-4143176a6900\\r\\nCorrelation ID: b57403ef-e775-49f6-b40f-009ba759c301\\r\\nTimestamp: 2021-06-30 21:12:34Z" } }, "description": "Only an example of 400 Error body" } } }, "description": "No description provided" } }, "callbacks": {}, "parameters": { "trait_headers_Accept": { "in": "header", "name": "Accept", "schema": { "type": "string", "default": "application/json" }, "required": true, "description": "Specifies the media type as \"application/json\"." }, "trait_jwt_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "required": true, "description": "JWT Bearer Token. Token URL: https://login.microsoftonline.com/xxxxxx-xxxxxxx-0f3b32b0xxxxx/oauth2/v2.0/token \r\n\r\n See example below.\r\n\r\n\ncurl --location --request POST 'https://login.microsoftonline.com/xxxxxx-xxxxxxx-0f3b32b0xxxxx/oauth2/v2.0/token' \r\n --header 'Content-Type: application/x-www-form-urlencoded' \r\n --header 'Cookie: fpc=xxxxxxxxxxxxxxxxA; stsservicecookie=estsfd; x-ms-gateway-slice=estsfd' \r\n --data-urlencode 'scope=api://testHarnessCustomersStage1/.default' \r\n --data-urlencode 'grant_type=client_credentials' \r\n --data-urlencode 'client_id=xxxxxxxxxx' \r\n --data-urlencode 'client_secret=xxxxxxxxxxx' \r\n\r\n Note: client id/secret are not the right ones - contact API provider, via 'Request Access' button to get the correct on" }, "trait_headers_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "required": true, "description": "Valid JSON Web Token." }, "trait_headers_X-ATT-CorrelationId": { "in": "header", "name": "X-ATT-CorrelationId", "schema": { "type": "string" }, "required": false, "description": "A GUID1 provided by the client that typically serves as a reference ID used to correlate client activity with transactions processed by the server. It is generally paired with the X-ATT-ConversationId to help with tracing and observability." }, "trait_error-responses_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "required": true, "description": "JWT Bearer Token. Token URL: https://login.microsoftonline.com/xxxxxx-xxxxxxx-0f3b32b0xxxx/oauth2/v2.0/token \r\n\r\n See example below.\r\n\r\n\ncurl --location --request POST 'https://login.microsoftonline.com/xxxxxx-xxxxxxx-0f3b32b0xxxx/oauth2/v2.0/token' \r\n --header 'Content-Type: application/x-www-form-urlencoded' \r\n --header 'Cookie: fpc=xxxxxxxxx; stsservicecookie=estsfd; x-ms-gateway-slice=estsfd' \r\n --data-urlencode 'scope=api://testHarnessCustomersStage1/.default' \r\n --data-urlencode 'grant_type=client_credentials' \r\n --data-urlencode 'client_id=xxxxxxx' \r\n --data-urlencode 'client_secret=xxxxxxxx' \r\n\r\n Note: client id/secret are not the right ones - contact API provider, via 'Request Access' button to get the correct on" }, "securityScheme_ATT_Azure_AD_JWT_Token_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "example": "Bearer eyJhbGciOiJIUzI1xxxxxxxtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTxxxxx4fwpMeJf36POxxxxxsw5c", "required": true, "description": "JWT Bearer Token" } }, "requestBodies": {}, "securitySchemes": { "ATT_Azure_AD_JWT_Token": { "type": "oauth2", "flows": { "authorizationCode": { "scopes": {}, "tokenUrl": "https://login.microsoftonline.com/xxxxxx-xxxxxxx-0f3b32b0xxxx/oauth2/v2.0/token", "authorizationUrl": "https://login.microsoftonline.com/xxxxxx-xxxxxxx-0f3b32b0xxxx/oauth2/v2.0/token" } }, "description": "Get a JWT Token from AT&T's Azure AD" } } } }