{ "info": { "title": "API Resource Inventory Management ", "version": "4.0.0", "description": "## TMF API Reference: TMF639 - Resource Inventory \n\n### Release : 19.5 - December 2019\n\nResource Inventory API goal is to provide the ability to manage Resources.\n\n### Operations\nResource Inventory API performs the following operations on the resources :\n- Retrieve an entity or a collection of entities depending on filter criteria\n- Partial update of an entity (including updating rules)\n- Create an entity (including default values and creation rules)\n- Delete an entity (for administration purposes)\n- Manage notification of events" }, "tags": [ { "name": "resource" }, { "name": "notification listeners (client side)" }, { "name": "events subscription" } ], "paths": { "/healthz": { "get": { "responses": { "200": { "description": "This resource helps us to give health of an application" } } } }, "/resource": { "get": { "tags": [ "resource" ], "summary": "Inquire device details & status", "responses": { "200": { "content": { "application/json": { "examples": { "default": { "value": [ { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource?mode=H&msisdn=1234567890&fields=DeviceDetail", "deviceDetails": { "id": "string", "imeiType": "string", "nfcCapabilityIndicator": "string", "imeiVersion": "string", "osVersion": "string", "osType": "string", "lteCapableDeviceFlag": "string", "manufacturer": { "make": "string", "model": "string", "marketingName": "string" }, "color": "string", "sku": "string", "isRefurbished": "string", "firstUseDate": "string", "manufactureDate": "string", "purchaseDate": "string", "warrantyEndDate": "string", "isHotlined": "string", "StolenDeviceDetails": { "msisdn": "string", "blacklistIndicator": "B", "blacklistEventDate": "string", "blockedIndicator": "string", "blockedEventDate": "string", "blockedNetworkEventDate": "string", "blacklistSubreasonDescription": "string" }, "BillingMarket": { "billingMarket": "string", "billingSubMarket": "string", "localMarket": "string" }, "InquireKey": { "billingAccountNumber": "string", "livingUnitId": "string", "circuitId": "string", "dtvBan": "string" }, "PartnerIdDetails": { "partnerId": "string", "imeiSKURequireFlag": "D" }, "sourceType": "string", "imeiTypeDetailsIndicator": "string", "softwareVersion": "string", "imeiTypeDetails": { "itemId": "string", "frequency": "string", "dataOnlyIndicator": "string", "dualModeServiceIndicator": "string", "imeiType": "string", "imeiSubtype": "string", "lteType": "string", "nfcCapability": "string", "umtsType": "string", "deviceCapability": "string", "OverrideIMEIData": { "softwareVersion": "string", "osVersion": "string", "osType": "string", "overriddenIMEIType": "string", "overriddenLTEType": "string", "overriddenDeviceCapability": "string" }, "ExceptionData": { "code": "string", "description": "string", "origination": "string" } }, "networkActivity": [ { "msisdn": "string", "activityDate": "string" } ], "imeiNumber1": "string", "imeiNumber2": "string" } } ] }, "device-Details-Response-mode D Subscriber": { "value": { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource?@type=MobileDevice&deviceDetails.mode=D&id=1234567&fields=deviceDetails", "deviceDetails": [ { "id": "string", "imeiType": "string", "imeiVersion": "string", "osVersion": "string", "osType": "string", "manufacturer": { "make": "string", "model": "string" }, "firstUseDate": "string", "imeiTypeDetails": { "itemId": "string", "frequency": "string", "dataOnlyIndicator": "string", "dualModeServiceIndicator": "string", "imeiType": "string", "imeiSubtype": "string", "lteType": "string", "nfcCapability": "string", "umtsType": "string", "deviceCapability": "string", "OverrideIMEIData": { "softwareVersion": "string", "osVersion": "string", "osType": "string", "overriddenIMEIType": "string", "overriddenLTEType": "string", "overriddenDeviceCapability": "string" } }, "@type": "MobileDevice" } ] } }, "device-Details-Response-mode C IMEI Indicator True": { "value": { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource?@type=MobileDevice&deviceDetails.mode=C&resourceRelationship.id=MSISDN-1234567&deviceDetails.imeiTypeDetailsIndicator=true&fields=deviceDetails", "deviceDetails": [ { "id": "string", "imeiType": "string", "manufacturer": { "make": "string", "model": "string" }, "imeiVersion": "string", "osVersion": "string", "osType": "string", "lteCapableDeviceFlag": "string", "firstUseDate": "string", "imeiTypeDetails": { "itemId": "string", "frequency": "string", "dataOnlyIndicator": "string", "dualModeServiceIndicator": "string", "imeiType": "string", "imeiSubtype": "string", "lteType": "string", "nfcCapability": "string", "umtsType": "string", "deviceCapability": "string", "OverrideIMEIData": { "softwareVersion": "string", "osVersion": "string", "osType": "string", "overriddenIMEIType": "string", "overriddenLTEType": "string", "overriddenDeviceCapability": "string" }, "ExceptionData": { "code": "string", "description": "string", "origination": "string" } }, "networkActivity": [ { "msisdn": "string", "activityDate": "string" } ], "imeiNumber1": "string", "imeiNumber2": "string", "@type": "MobileDevice" } ] } }, "device-Details-Response-mode C IMEI Indicator False": { "value": { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource?@type=MobileDevice&deviceDetails.mode=C&resourceRelationship.id=MSISDN-1234567&fields=deviceDetails", "deviceDetails": [ { "id": "string", "imeiType": "string", "manufacturer": { "make": "string", "model": "string" }, "imeiVersion": "string", "osVersion": "string", "osType": "string", "lteCapableDeviceFlag": "string", "firstUseDate": "string", "@type": "MobileDevice" } ] } }, "device-Details-Response-mode T imeiSKURequireFlag T": { "value": { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource?@type=MobileDevice&deviceDetails.mode=T&id=1234567&billingMarket=NBI&billingSubMarket=NBI&deviceDetails.imeiSKURequireFlag=T&deviceDetails.fields=deviceDetails", "deviceDetails": [ { "id": "string", "imeiTypeDetails": { "itemId": "string", "frequency": "string", "dataOnlyIndicator": "string", "dualModeServiceIndicator": "string", "imeiType": "string", "imeiSubtype": "string", "lteType": "string", "nfcCapability": "string", "umtsType": "string", "deviceCapability": "string", "OverrideIMEIData": { "softwareVersion": "string", "osVersion": "string", "osType": "string", "overriddenIMEIType": "string", "overriddenLTEType": "string", "overriddenDeviceCapability": "string" } }, "@type": "MobileDevice" } ] } }, "device-Details-Response-mode H IMEI & IMEI Indicator True": { "value": { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource?@type=MobileDevice&deviceDetails.mode=H&deviceDetails.imeiTypeDetailsIndicator=true&billingMarket=NBI&billingSubMarket=NBI&fields=deviceDetails&id=1234567", "deviceDetails": [ { "id": "string", "manufacturer": { "make": "string", "model": "string" }, "color": "string", "sku": "string", "isRefurbished": "string", "firstUseDate": "string", "manufactureDate": "string", "purchaseDate": "string", "warrantyEndDate": "string", "isHotlined": "string", "StolenDeviceDetails": { "msisdn": "string", "blacklistIndicator": "B", "blacklistEventDate": "string", "blockedIndicator": "string", "blockedEventDate": "string", "blockedNetworkEventDate": "string", "blacklistSubreasonDescription": "string" }, "DeviceSelector": { "imei": "string" }, "softwareVersion": "string", "imeiTypeDetails": { "umtsType": "string" }, "networkActivity": [ { "msisdn": "string", "activityDate": "string" } ], "imeiNumber1": "string", "imeiNumber2": "string", "@type": "MobileDevice" } ] } }, "device-Details-Response-mode H IMEI & IMEI Indicator False": { "value": { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource?@type=MobileDevice&deviceDetails.mode=H&deviceDetails.imeiTypeDetailsIndicator=false&billingMarket=NBI&billingSubMarket=NBI&deviceDetails.partnerId=ZTAR&fields=deviceDetails&id=1234567", "deviceDetails": { "id": "string", "sku": "string", "color": "string", "@type": "MobileDevice", "isHotlined": "string", "imeiNumber1": "string", "imeiNumber2": "string", "manufacturer": { "make": "string", "model": "string" }, "firstUseDate": "string", "purchaseDate": "string", "isRefurbished": "string", "ExceptionData": { "code": "string", "description": "string", "origination": "string" }, "DeviceSelector": { "imei": "string" }, "manufactureDate": "string", "warrantyEndDate": "string", "softwareVersion": "string", "imeiTypeDetails": { "umtsType": "string" }, "networkActivity": [ { "msisdn": "string", "activityDate": "string" } ], "StolenDeviceDetails": { "msisdn": "string", "blockedIndicator": "string", "blockedEventDate": "string", "blacklistIndicator": "B", "blacklistEventDate": "string", "blockedNetworkEventDate": "string", "blacklistSubreasonDescription": "string" } } } }, "device-Details-Response-mode H Subscriber & IMEI Indicator True": { "value": { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource?@type=MobileDevice&deviceDetails.mode=H&resourceRelationship.id=MSISDN-1234567&deviceDetails.imeiTypeDetailsIndicator=true&fields=deviceDetails", "deviceDetails": [ { "id": "string", "manufacturer": { "make": "string", "model": "string" }, "color": "string", "sku": "string", "isRefurbished": "string", "firstUseDate": "string", "manufactureDate": "string", "purchaseDate": "string", "warrantyEndDate": "string", "isHotlined": "string", "StolenDeviceDetails": { "msisdn": "string", "blacklistIndicator": "B", "blacklistEventDate": "string", "blockedIndicator": "string", "blockedEventDate": "string", "blockedNetworkEventDate": "string", "blacklistSubreasonDescription": "string" }, "DeviceSelector": { "imei": "string" }, "softwareVersion": "string", "imeiTypeDetails": { "itemId": "string", "frequency": "string", "dataOnlyIndicator": "string", "dualModeServiceIndicator": "string", "imeiType": "string", "imeiSubtype": "string", "lteType": "string", "nfcCapability": "string", "umtsType": "string", "deviceCapability": "string", "OverrideIMEIData": { "softwareVersion": "string", "osVersion": "string", "osType": "string", "overriddenIMEIType": "string", "overriddenLTEType": "string", "overriddenDeviceCapability": "string" }, "ExceptionData": { "code": "string", "description": "string", "origination": "string" } }, "networkActivity": [ { "msisdn": "string", "activityDate": "string" } ], "imeiNumber1": "string", "imeiNumber2": "string", "@type": "MobileDevice" } ] } }, "device-Details-Response-mode H Subscriber & IMEI Indicator False": { "value": { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource?@type=MobileDevice&deviceDetails.mode=H&resourceRelationship.id=MSISDN-1234567&fields=deviceDetailsl", "deviceDetails": [ { "id": "string", "manufacturer": { "make": "string", "model": "string" }, "color": "string", "sku": "string", "isRefurbished": "string", "firstUseDate": "string", "manufactureDate": "string", "purchaseDate": "string", "warrantyEndDate": "string", "isHotlined": "string", "StolenDeviceDetails": { "msisdn": "string", "blacklistIndicator": "B", "blacklistEventDate": "string", "blockedIndicator": "string", "blockedEventDate": "string", "blockedNetworkEventDate": "string", "blacklistSubreasonDescription": "string" }, "DeviceSelector": { "imei": "string" }, "softwareVersion": "string", "imeiTypeDetails": { "umtsType": "string" }, "networkActivity": [ { "msisdn": "string", "activityDate": "string" } ], "imeiNumber1": "string", "imeiNumber2": "string", "@type": "MobileDevice" } ] } }, "device-Details-Response-mode D Subscriber & SourceType=NETWORK_DATA": { "value": { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource?@type=MobileDevice&deviceDetails.mode=D&resourceRelationship.id=MSISDN-1234567&billingMarket=NBI&billingSubMarket=NBI&deviceDetails.sourceType=NETWORK_DATA&fields=deviceDetails", "deviceDetails": [ { "imeiTypeDetails": { "itemId": "string", "frequency": "string", "dataOnlyIndicator": "string", "dualModeServiceIndicator": "string", "imeiType": "string", "imeiSubtype": "string", "lteType": "string", "nfcCapability": "string", "umtsType": "string", "deviceCapability": "string", "OverrideIMEIData": { "softwareVersion": "string", "osVersion": "string", "osType": "string", "overriddenIMEIType": "string", "overriddenLTEType": "string", "overriddenDeviceCapability": "string" } }, "imeiNumber1": "string", "imeiNumber2": "string", "@type": "MobileDevice" } ] } } } } }, "headers": { "X-Total-Count": { "schema": { "type": "integer" }, "description": "Total number of items matching criteria" }, "X-Result-Count": { "schema": { "type": "integer" }, "description": "Actual number of items returned in the response body" } }, "description": "Success" }, "400": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" }, "example": { "error": "Forbidden", "status": "Failure", "message": "Forbidden" } } }, "description": "Forbidden" }, "404": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" }, "example": { "error": "Resource Not Found", "status": "Failure", "message": "Resource not found" } } }, "description": "Not Found" }, "405": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" }, "example": { "error": "Method Not Allowed", "status": "Failure", "message": "Method not allowed / implemented" } } }, "description": "Method Not allowed" }, "406": { "$ref": "#/components/responses/trait_ErrorResponses_406" }, "409": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" } } }, "description": "Conflict" }, "415": { "$ref": "#/components/responses/trait_ErrorResponses_415" }, "500": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" }, "example": { "error": "Internal Server Error", "status": "Failure", "message": "Internal Server Error" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "name": "@type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "MobileDevice" ] }, "description": "This represent type of model", "example": "MobileDevice" }, { "name": "deviceDetails.mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "C", "H", "D", "S", "A", "T", "DU" ] }, "description": "Comma-separated properties to provide in response" }, { "name": "resourceRelationship.id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "\\d{10}$" }, "description": "Use for Subscriber Number", "example": "2054825324" }, { "name": "resourceRelationship.@type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "MSISDN" ] }, "description": "This represent resource Relationshiptype of model", "example": "MSISDN" }, { "name": "id", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 15, "pattern": "^[0-9]+$" }, "description": "Use for SIM IMEI number. Required for mode A and mode T" }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "deviceDetails", "deviceStatusDetails" ] }, "description": "Fields is used to indicate which object’s details will be returned" }, { "name": "billingMarket", "in": "query", "required": false, "schema": { "type": "string", "pattern": "[A-Z]{3}$" }, "description": "If mode D or T are sent or imeiTypeDetailsIndicator is True, then this should be populated.", "example": "NBI" }, { "name": "billingSubMarket", "in": "query", "required": false, "schema": { "type": "string", "pattern": "[A-Z0-9]{2,3}$" }, "example": "NBI" }, { "name": "localMarket", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Contains the Market from which the NBI Customer was migrated" }, { "name": "deviceDetails.partnerId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "deviceDetails.imeiSKURequireFlag", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "D", "T", "B" ] }, "description": "Indicates if the client requested to call for dlc data or tlg data or both. Valid Values D – requested for dlc call T – requested for Telegence call B – requested for both" }, { "name": "deviceDetails.sourceType", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Required when requested for biller or network imei or both", "example": "deviceDetails.sourceType=NETWORK_DATA" }, { "name": "deviceDetails.imeiTypeDetailsIndicator", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Set True to request IMEITypeDetails information to be returned with mode H or C. IMEITypeDetails is returned by default with mode T and D." }, { "name": "deviceDetails.softwareVersion", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Used with IMEI to return a specific IMEI Type, LTE Type and Device Capability for the requested software version", "example": "deviceDetails.softwareVersion=19" }, { "$ref": "#/components/parameters/trait_jwt_Authorization" }, { "$ref": "#/components/parameters/trait_headers_x-att-clientId" }, { "$ref": "#/components/parameters/trait_headers_x-att-conversationId" }, { "$ref": "#/components/parameters/trait_headers_x-att-correlationId" } ], "x-page-slug": "inquire-device-details", "description": "This operation retrieves Resource entities - device details. (TMF 639)", "operationId": "Inquire device details & status" } }, "/resource/{id}": { "get": { "tags": [ "resource" ], "summary": "Inquire device status by IMEI", "responses": { "200": { "content": { "application/json": { "examples": { "deviceStatusDetailsResponseGrid": { "value": { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource/MobileDevice-1234567?fields=deviceStatusDetails", "deviceStatusDetails": { "@type": "MobileDevice", "lteType": "6", "imeiType": "LTE", "frequency": "10", "imeiItemId": "123", "manufacturer": { "make": "APPLE", "model": "iPhone5", "marketingName": "Apple Inc." }, "nfcCapability": "U", "attCompatibility": "Green", "dataOnlyIndicator": "true", "blacklistStatusDate": "2001-12-17T09:30:47Z", "blacklistedIndicator": "B", "umtsCapableIndicator": "true", "volteSupportIndicator": "true", "deviceCapabilitiesType": "A", "certificationStateIndicator": "true" } } }, "deviceStatusDetailsResponseModeDU": { "value": { "id": "1234567", "href": "https://tmf639-resourceinventory-mobiledevice.gw.cloud.att.com/api/resource/MobileDevice-1234567?deviceStatusDetails.mode=DU&fields=deviceStatusDetails", "deviceUnlockDetails": { "@type": "MobileDevice", "unlockDate": "2001-12-17T09:30:47Z", "statusDescription": "Device unlocked", "deviceUnlockProfile": { "status": "Success", "message": "unlock successful" } } } } } } }, "description": "Success" }, "400": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" }, "example": { "error": "Forbidden", "status": "Failure", "message": "Forbidden" } } }, "description": "Forbidden" }, "404": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" }, "example": { "error": "Resource Not Found", "status": "Failure", "message": "Resource not found" } } }, "description": "Not Found" }, "405": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" }, "example": { "error": "Method Not Allowed", "status": "Failure", "message": "Method not allowed / implemented" } } }, "description": "Method Not allowed" }, "406": { "$ref": "#/components/responses/trait_ErrorResponses_406" }, "409": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" } } }, "description": "Conflict" }, "415": { "$ref": "#/components/responses/trait_ErrorResponses_415" }, "500": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/deviceLib_Error" }, "example": { "error": "Internal Server Error", "status": "Failure", "message": "Internal Server Error" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "deviceDetails", "deviceStatusDetails" ] }, "description": "Fields is used to indicate which object’s details will be returned" }, { "name": "@type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "MobileDevice" ] }, "description": "type of resource", "example": "MobileDevice" }, { "name": "deviceStatusDetails.mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "DU" ] }, "description": "Mode to retrieve Device Unlock Details from Torch. Value is DU=DeviceUnlock.", "example": "DU" }, { "$ref": "#/components/parameters/trait_jwt_Authorization" }, { "$ref": "#/components/parameters/trait_headers_x-att-clientId" }, { "$ref": "#/components/parameters/trait_headers_x-att-conversationId" }, { "$ref": "#/components/parameters/trait_headers_x-att-correlationId" } ], "x-page-slug": "retrieve-device-status", "description": "This operation retrieves a Resource entity. Attribute selection is enabled for all first level attributes. Retrieves device unlock status. (TMF 639)", "operationId": "Inquire device status by IMEI" }, "parameters": [ { "in": "path", "required": true, "name": "id", "schema": { "type": "string", "maxLength": 15, "pattern": "^[0-9]+$" }, "description": "IMEI of the Resource" } ] } }, "openapi": "3.0.3", "security": [], "components": { "links": {}, "schemas": { "healthCheck": { "type": "object", "required": [ "application_name", "message", "time" ], "properties": { "time": { "type": "string" }, "message": { "type": "string" }, "application_name": { "type": "string" } } }, "deviceLib_Note": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)" }, "href": { "type": "string", "description": "Hyperlink reference" }, "date": { "type": "string", "format": "date-time", "description": "Date of the note" }, "text": { "type": "string", "description": "Text of the note" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "author": { "type": "string", "description": "Author of the note" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Extra information about a given entity" }, "deviceLib_Place": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "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." }, "deviceLib_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "Application relevant detail, defined in the API or a common list." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "reason": { "type": "string", "description": "Explanation of the reason for the error which can be shown to a client user." }, "status": { "type": "string", "description": "HTTP Error code extension" }, "message": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "referenceError": { "type": "string", "description": "URI of documentation describing the error." }, "@schemaLocation": { "type": "string", "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)" }, "deviceLib_Entity": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Base entity schema for use in TMForum Open-APIs" }, "deviceLib_Feature": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the feature." }, "name": { "type": "string", "description": "This is the name for the feature." }, "isBundle": { "type": "boolean", "description": "True if this is a feature group. Default is false." }, "isEnabled": { "type": "boolean", "description": "True if this feature is enabled. Default is true." }, "constraint": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_ConstraintRef" }, "description": "This is a list of feature constraints." }, "featureRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_FeatureRelationship" } }, "featureCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Characteristic" }, "minItems": 1, "description": "This is a list of Characteristics for a particular feature." } }, "description": "Configuration feature." }, "deviceLib_PlaceRef": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "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." }, "deviceLib_Quantity": { "type": "object", "properties": { "units": { "type": "string", "description": "Unit" }, "amount": { "type": "number", "format": "float", "default": 1, "description": "Numeric value in a given unit" } }, "description": "An amount in a given unit" }, "deviceLib_Resource": { "type": "object", "properties": { "id": { "type": "string", "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", "description": "The URI for the object itself." }, "name": { "type": "string", "description": "A string used to give a name to the resource" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Note" } }, "place": { "$ref": "#/components/schemas/deviceLib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_AttachmentRefOrValue" } }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceUsageStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "description": { "type": "string", "description": "free-text description of the resource" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_RelatedParty" } }, "resourceStatus": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceStatusType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceOperationalStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "activationFeature": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Feature" }, "description": "Configuration features" }, "startOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceAdministrativeStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/deviceLib_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Characteristic" } } }, "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory." }, "deviceLib_EntityRef": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "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." }, "deviceLib_Attachment": { "type": "object", "properties": { "id": { "type": "string", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "Unique identifier for this particular attachment" }, "url": { "type": "string", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "Uniform Resource Locator, is a web page address (a subset of URI)" }, "href": { "type": "string", "example": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "URI for this Attachment" }, "name": { "type": "string", "description": "The name of the attachment" }, "size": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_Quantity" } ], "description": "The size of the attachment." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "content": { "type": "string", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "mimeType": { "type": "string", "description": "Attachment mime type such as extension file for video, picture and document" }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_TimePeriod" } ], "description": "The period of time for which the attachment is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "example": "Photograph of the Product", "description": "A narrative text describing the content of the attachment" }, "attachmentType": { "type": "string", "example": "video", "description": "Attachment type such as video, picture" }, "@schemaLocation": { "type": "string", "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..." }, "deviceLib_Extensible": { "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Base Extensible schema for use in TMForum Open-APIs" }, "deviceLib_TimePeriod": { "type": "object", "properties": { "endDateTime": { "type": "string", "format": "date-time", "example": "1985-04-12T23:20:50.52Z", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "type": "string", "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" }, "deviceLib_Addressable": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" } }, "description": "Base schema for adressable entities" }, "deviceLib_ResourceRef": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "deviceLib_MobileDevice": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/deviceLib_Resource" }, { "type": "object", "properties": { "deviceDetails": { "$ref": "#/components/schemas/deviceLib_DeviceDetails" }, "deviceStatusDetails": { "$ref": "#/components/schemas/deviceLib_DeviceStatusDetails" } }, "description": "Device" } ] }, "deviceLib_RelatedParty": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string", "description": "Role played by the related party" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "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." }, "deviceLib_DeviceDetails": { "type": "object", "properties": { "sku": { "type": "string", "description": "Stock Keeping Unit" }, "color": { "type": "string" }, "osType": { "type": "string", "description": "Operating System type. Examples includes IOS, ANDROID, BLACKBERRY, WINDOWS, SYMBIAN and PROPRIETARY" }, "imeiType": { "type": "string", "description": "IMEI type can be returned if mode is C in the request" }, "osVersion": { "type": "string", "description": "Operating System version number. Example '7.0.4 (900305)'" }, "isHotlined": { "type": "string" }, "InquireKey": { "type": "object", "properties": { "dtvBan": { "type": "string", "description": "Direct TV BAN to inquire CustomerPremiseEquipment" }, "circuitId": { "type": "string" }, "livingUnitId": { "type": "string" }, "billingAccountNumber": { "type": "string", "description": "Uverse BAN to inquire CustomerPremiseEquipment" } }, "description": "Required for Mode O" }, "sourceType": { "type": "string", "description": "It is require when requested for biller or network imei or both" }, "imeiVersion": { "type": "string", "description": "IMEI software version number. As per 3GPP standards it should be a two digit number with values from 00 – 99 " }, "imeiNumber1": { "type": "string", "description": "Physical IMEI of the device Returned for Mode H" }, "imeiNumber2": { "type": "string", "description": "eIMEI or complimentary IMEI of the device Returned for Mode H" }, "manufacturer": { "type": "object", "properties": { "make": { "type": "string" }, "model": { "type": "string" }, "marketingName": { "type": "string", "description": "Device friendly name" } } }, "firstUseDate": { "type": "string", "description": "In case of an IMEI number as as input it will indicate first time when the device was used on the network. In case of CTN as an input it will indicate the first activation date corresponding to the IMEI number" }, "purchaseDate": { "type": "string" }, "isRefurbished": { "type": "string" }, "BillingMarket": { "type": "object", "properties": { "localMarket": { "type": "string", "description": "Contains the Market from which the NBI Customer was migrated" }, "billingMarket": { "type": "string" }, "billingSubMarket": { "type": "string" } }, "description": "If mode D or T are sent or imeiTypeDetailsIndicator is True, then this should be populated." }, "manufactureDate": { "type": "string" }, "warrantyEndDate": { "type": "string" }, "softwareVersion": { "type": "string", "description": "Used with IMEI to return a specific IMEI Type, LTE Type and Device Capability for the requested software version" }, "imeiTypeDetails": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_IMEITypeDetails" } ], "description": "Will be returned when Mode is D or T OR C or H when imeiypeDetailsIndicator = True" }, "networkActivity": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_NetworkActivity" } }, "PartnerIdDetails": { "type": "object", "properties": { "partnerId": { "type": "string" }, "imeiSKURequireFlag": { "type": "string", "enum": [ "D", "T", "B" ], "description": "Indicates if the client requested to call for dlc data or tlg data or both Valid Values D – requested for dlc call T – requested for Telegence call B – requested for both" } } }, "StolenDeviceDetails": { "type": "object", "properties": { "msisdn": { "type": "string" }, "blockedIndicator": { "type": "string", "description": "True is Blocked, False is not blocked." }, "blockedEventDate": { "type": "string" }, "blacklistIndicator": { "type": "string", "enum": [ "B", "U", "N" ], "description": "B-Blacklisted, U-Unblacklisted, N-Neither Blacklisted nor UnBlacklisted." }, "blacklistEventDate": { "type": "string", "description": "Will not be populated if blacklistedIndicator is equal to N." }, "blockedNetworkEventDate": { "type": "string", "description": "EIRNetwork date, indicates whether DLC triggered an 'auto-suspend' action for the IMEI/CTN combination. Will not be populated if blockedIndicator is equal to false." }, "blacklistSubreasonDescription": { "type": "string", "description": "the subreason why a device has been blacklisted returned only for mode H. Example values : Black, Red, etc." } }, "description": "This applies when mode equal to H." }, "lteCapableDeviceFlag": { "type": "string" }, "nfcCapabilityIndicator": { "type": "string", "description": "indicates device has Near Field Communication capability or not. Examples: N = Device does not have NFC capability or cannot be used with any NFC or Secure Element components. E = Device embeds both the NFC and SE components. M = Device can work with NFC enabled microSD (that embeds both the NFC and SE components). S = Device can work with NFC enabled microSD and UICCs (SIM cards that embeds both the NFC and SE components - SIM Wrappers.) U = Device embeds only the NFC component, but needs to work with UICCs (SIM Cards) that include the SE component to support payment applications. EU = Device embeds the NFC and SE components and also accepts SE in the UICC." }, "attShippedDeviceDetails": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ATTShippedDeviceDetails" } ], "description": "Returned for Mode A" }, "imeiTypeDetailsIndicator": { "type": "string", "description": "Set True to request IMEITypeDetails information to be returned with mode H or C. IMEITypeDetails is returned by default with mode T and D." }, "outdoorWirelessAntennaDetails": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_OutdoorWirelessAntennaDetails" } ], "description": "Returned for Mode O" }, "searchReturnInstallmentPlanDevices": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_SearchReturnInstallmentPlanDevices" } ], "description": "Returned for Mode S" } }, "description": "Device Details" }, "deviceLib_AttachmentRef": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique-Identifier for this attachment" }, "url": { "type": "string", "description": "Link to the attachment media/content" }, "href": { "type": "string", "description": "URL serving as reference for the attachment resource" }, "name": { "type": "string", "description": "Name of the related entity." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "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" }, "deviceLib_ConstraintRef": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "version": { "type": "string", "description": "constraint version" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "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." }, "deviceLib_Characteristic": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "name": { "type": "string", "description": "Name of the characteristic" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "characteristicRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_CharacteristicRelationship" } } }, "description": "Describes a given characteristic of an object or entity through a name/value pair." }, "deviceLib_IMEITypeDetails": { "type": "object", "properties": { "itemId": { "type": "string" }, "lteType": { "type": "string", "description": "Indicates the LTE type if LTE capable. Valid values: 5 - LTE Data only. 6 - LTE Data and Voice w/CSFB only. 7 - LTE Data and Voice w/IMS/CSFB. " }, "imeiType": { "type": "string", "description": "IMEI type can be returned if mode is D in the request" }, "umtsType": { "type": "string", "description": "Indicate if the IMEI range is UMTS capable. Valid values: U - UMTS IMEI. P - PC Card. N - Non UMTS." }, "frequency": { "type": "string", "description": "IMEI Frequency 850, 900, 1800, 1900." }, "imeiSubtype": { "type": "string", "description": "W - Wintergreen. C - Calico. If not present, it is Non IMEI sub type." }, "nfcCapability": { "type": "string", "description": "NearFeildCommunication - This field will hold the NFC capability code. Valid values: N - No NFC capability. E - Embedded NFC. M - MicroSD. S - SIM Card. MS - MicroSD and SIM card." }, "ExceptionData": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "origination": { "type": "string" } }, "description": "ExceptionData contains soft error from TLG" }, "deviceCapability": { "type": "string", "description": "Value consists of code values separated by semicolons. Possible values include: IR94, IPME, IPME2, NSDEV. For example: IR94; IPME; " }, "OverrideIMEIData": { "type": "object", "properties": { "osType": { "type": "string", "description": "Operating System type. Examples include : IOS, ANDROID, BLACKBERRY, WINDOWS, SYMBIAN and PROPRIETARY" }, "osVersion": { "type": "string", "description": "Operating System version number. Example '7.0.4 (900305)'" }, "softwareVersion": { "type": "string", "description": "IMEI software version number. As per 3GPP standards it should be a two digit numbers with values from 00 – 99" }, "overriddenLTEType": { "type": "string", "description": "Typically a one-digit number with values including: 5 (LTE data only), 6 (LTE data with circuit-switched voice), 7 (LTE data with VoLTE and circuit-switched voice) 8 (LTE data with unconditional non-IMS service provisioning and circuit-switched voice)" }, "overriddenIMEIType": { "type": "string", "description": "Typically a two character value used to identify device types for the purpose of restricting the availability/compatibility of products (e.g., data plans) by device type. It has values such as P6, P9, L5" }, "overriddenDeviceCapability": { "type": "string", "description": "Value consists of code values separated by semicolons. Possible values include: IR94, IPME, IPME2, NSDEV. For example: IR94; IPME;" } }, "description": "Returned only when softwareVersion is NOT in request" }, "dataOnlyIndicator": { "type": "string", "description": "DataOnly Device if it is True" }, "dualModeServiceIndicator": { "type": "string", "description": "Indicates if IMEI range is capable for having DMS." } }, "description": "Device Details" }, "deviceLib_NetworkActivity": { "type": "object", "properties": { "msisdn": { "type": "string" }, "activityDate": { "type": "string", "description": "The oldest activation date of the particular IMEI and the PhoneNnumber" } }, "description": "Will be returned only if IMEI is parsed as input" }, "deviceLib_LogicalResource": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "A string used to give a name to the resource" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Note" } }, "value": { "type": "string", "description": "the value of the logical resource. E.g '0746712345' for MSISDN's" }, "place": { "$ref": "#/components/schemas/deviceLib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_AttachmentRefOrValue" } }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceUsageStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "description": { "type": "string", "description": "free-text description of the resource" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_RelatedParty" } }, "resourceStatus": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceStatusType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceOperationalStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "activationFeature": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Feature" }, "description": "Configuration features" }, "startOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceAdministrativeStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/deviceLib_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Characteristic" } } }, "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." }, "deviceLib_Resource_Create": { "type": "object", "properties": { "name": { "type": "string", "description": "A string used to give a name to the resource" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Note" } }, "place": { "$ref": "#/components/schemas/deviceLib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_AttachmentRefOrValue" } }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceUsageStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "description": { "type": "string", "description": "free-text description of the resource" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_RelatedParty" } }, "resourceStatus": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceStatusType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceOperationalStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "activationFeature": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Feature" }, "description": "Configuration features" }, "startOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceAdministrativeStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/deviceLib_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Characteristic" } } }, "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.\nSkipped properties: id,href" }, "deviceLib_Resource_Update": { "type": "object", "properties": { "name": { "type": "string", "description": "A string used to give a name to the resource" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Note" } }, "place": { "$ref": "#/components/schemas/deviceLib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_AttachmentRefOrValue" } }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceUsageStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "description": { "type": "string", "description": "free-text description of the resource" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_RelatedParty" } }, "resourceStatus": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceStatusType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceOperationalStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "activationFeature": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Feature" }, "description": "Configuration features" }, "startOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceAdministrativeStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/deviceLib_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Characteristic" } } }, "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.\nSkipped properties: id,href" }, "deviceLib_PhysicalResource": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "A string used to give a name to the resource" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Note" } }, "place": { "$ref": "#/components/schemas/deviceLib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "powerState": { "type": "string", "description": "This defines the current power status of the hardware item. Values include:\n\n 0: Unknown\n 1: Not Applicable\n 2: No Power Applied\n 3: Full Power Applied\n 4: Power Save - Normal\n 5: Power Save - Degraded\n 6: Power Save - Standby\n 7: Power Save - Critical\n 8: Power Save - Low Power Mode\n 9: Power Save - Unknown\n10: Power Cycle\n11: Power Warning\n12: Power Off" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_AttachmentRefOrValue" } }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceUsageStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "description": { "type": "string", "description": "free-text description of the resource" }, "serialNumber": { "type": "string", "description": "This is a string that represents a manufacturer-allocated number used to identify different instances of the same hardware item. The ModelNumber and PartNumber attributes are used to identify different types of hardware items. This is a REQUIRED attribute." }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_RelatedParty" } }, "versionNumber": { "type": "string", "description": "This is a string that identifies the version of this physical resource. This is an optional attribute." }, "resourceStatus": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceStatusType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "manufactureDate": { "type": "string", "format": "date-time", "description": "This is a string attribute that defines the date of manufacture of this item in the fixed format \"dd/mm/yyyy\". This is an optional attribute." }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceOperationalStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "activationFeature": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Feature" }, "description": "Configuration features" }, "startOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceAdministrativeStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/deviceLib_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Characteristic" } } }, "description": "Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory." }, "deviceLib_EventSubscription": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the listener" }, "query": { "type": "string", "description": "additional data to be passed" }, "callback": { "type": "string", "description": "The callback being registered." } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "deviceLib_ResourceRefOrValue": { "type": "object", "properties": { "id": { "type": "string", "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", "description": "The URI for the object itself." }, "name": { "type": "string", "description": "A string used to give a name to the resource" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Note" } }, "place": { "$ref": "#/components/schemas/deviceLib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_AttachmentRefOrValue" } }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceUsageStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "description": { "type": "string", "description": "free-text description of the resource" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_RelatedParty" } }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "resourceStatus": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceStatusType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceOperationalStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "activationFeature": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Feature" }, "description": "Configuration features" }, "startOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceAdministrativeStateType" } ], "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on." }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/deviceLib_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/deviceLib_Characteristic" } } }, "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" }, "deviceLib_ResourceStatusType": { "type": "string", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ], "description": "ResourceStatusType enumerations" }, "deviceLib_DeviceStatusDetails": { "type": "object", "properties": { "lteType": { "type": "string", "enum": [ "5", "6", "7" ], "description": "Values: 5 - LTE Data only, 6 - LTE Data and Voice w/CSFB only, 7 - LTE Data and Voice w/IMS/CSFB. If not populated; device is not lte capability " }, "imeiType": { "type": "string" }, "frequency": { "type": "string" }, "imeiItemId": { "type": "string" }, "manufacturer": { "type": "object", "properties": { "make": { "type": "string" }, "model": { "type": "string" }, "marketingName": { "type": "string" } } }, "nfcCapability": { "type": "string", "description": "ex: N, U, IU" }, "deviceCategory": { "type": "string", "description": "The Device Category. For example: SmartPhone, LTE, Feature Phone" }, "attCompatibility": { "type": "string", "enum": [ "Green", "Yellow", "Red" ], "description": "Green, Yellow, Red" }, "dataOnlyIndicator": { "type": "string" }, "blacklistStatusDate": { "type": "string", "format": "date-time", "description": "Indicates when the device was reported Blacklisted or UnBlacklisted." }, "deviceUnlockDetails": { "type": "object", "properties": { "unlockDate": { "type": "string", "format": "date-time", "description": "Indicates when the device was successfully unlocked." }, "statusDescription": { "type": "string", "description": "Description of the transaction, can contain a message even when status is Success." }, "deviceUnlockProfile": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of the call. Success means that this device is now registered to be unlocked, and will also be returned if the device was already registered to be unlocked. Failure will be returned for any situation where the unlock request was not successfully registered." }, "message": { "type": "string", "description": "Indicates whether or not the unlock request was sent and received successful or not at Apple Inc. Potential values are: AL_BAD_REQUEST AL_INTERNAL_ERROR AL_FORBIDDEN AL_NOT_FOUND AL_PENDING_UNLOCK This optional field is not present when the status above is ‘Success’ " } } } } }, "blacklistedIndicator": { "type": "string", "enum": [ "B", "U", "N" ], "description": "B - Blacklisted U - UnBlacklisted N - Neither Blacklisted nor unBlacklisted" }, "umtsCapableIndicator": { "type": "string" }, "volteSupportIndicator": { "type": "string" }, "deviceCapabilitiesType": { "type": "string", "description": "Network device capabilities, ex: A - 5G NSA data and VoLTE voice, B - 5G SA Data only, D - 5G SA Data and voice using VoNR" }, "certificationStateIndicator": { "type": "string" } } }, "deviceLib_FeatureRelationship": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the target feature." }, "name": { "type": "string", "description": "This is the name of the target feature." }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_TimePeriod" } ], "description": "The period for which this feature relationship is valid." }, "relationshipType": { "type": "string", "description": "This is the type of the feature relationship." } }, "description": "Configuration feature" }, "deviceLib_ResourceCreateEvent": { "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceCreateEventPayload" } ], "description": "The event payload linked to the involved resource object" }, "title": { "type": "string", "description": "The title of the event." }, "domain": { "type": "string", "description": "The domain of the event." }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "priority": { "type": "string", "description": "A priority." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } }, "description": "The notification data structure" }, "deviceLib_ResourceDeleteEvent": { "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceDeleteEventPayload" } ], "description": "The event payload linked to the involved resource object" }, "title": { "type": "string", "description": "The title of the event." }, "domain": { "type": "string", "description": "The domain of the event." }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "priority": { "type": "string", "description": "A priority." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } }, "description": "The notification data structure" }, "deviceLib_AttachmentRefOrValue": { "type": "object", "properties": { "id": { "type": "string", "example": "xxxxxxxx", "description": "Unique identifier for this particular attachment" }, "url": { "type": "string", "example": "http://host/Content/xxxxxxxx", "description": "Uniform Resource Locator, is a web page address (a subset of URI)" }, "href": { "type": "string", "example": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "URI for this Attachment" }, "name": { "type": "string", "description": "The name of the attachment" }, "size": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_Quantity" } ], "description": "The size of the attachment." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "content": { "type": "string", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "mimeType": { "type": "string", "description": "Attachment mime type such as extension file for video, picture and document" }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_TimePeriod" } ], "description": "The period of time for which the attachment is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "example": "Photograph of the Product", "description": "A narrative text describing the content of the attachment" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "attachmentType": { "type": "string", "example": "video", "description": "Attachment type such as video, picture" }, "@schemaLocation": { "type": "string", "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." }, "deviceLib_ResourceRelationship": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "resource": { "$ref": "#/components/schemas/deviceLib_ResourceRefOrValue" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "relationshipType": { "type": "string", "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" }, "deviceLib_RelatedPlaceRefOrValue": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "role": { "type": "string" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "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" }, "deviceLib_ResourceUsageStateType": { "type": "string", "enum": [ "idle", "active", "busy" ], "description": "ResourceUsageStateType enumerations" }, "deviceLib_EventSubscriptionInput": { "type": "object", "properties": { "query": { "type": "string", "description": "additional data to be passed" }, "callback": { "type": "string", "description": "The callback being registered." } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "deviceLib_ATTShippedDeviceDetails": { "type": "object", "properties": { "sku": { "type": "string", "description": "Returned only if transactionStatus =SUCCESSstandby" }, "transactionStatus": { "type": "string", "description": "Example values :SUCCESS or NODATA" }, "deviceShippedStatus": { "type": "string", "description": "Tells whether a particular device is shipped by ATT or not. Example values Y,0 N, NA (if shipment is not applicable). Returned only if transactionStatus =SUCCESS" } }, "description": "Returned for Mode A" }, "deviceLib_ResourceSpecificationRef": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "version": { "type": "string", "description": "Resource Specification version" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "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.\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." }, "deviceLib_ResourceStateChangeEvent": { "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceStateChangeEventPayload" } ], "description": "The event payload linked to the involved resource object" }, "title": { "type": "string", "description": "The title of the event." }, "domain": { "type": "string", "description": "The domain of the event." }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "priority": { "type": "string", "description": "A priority." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } }, "description": "The notification data structure" }, "deviceLib_CharacteristicRelationship": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "href": { "type": "string", "description": "Hyperlink reference" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "relationshipType": { "type": "string", "description": "The type of relationship" } }, "description": "Another Characteristic that is related to the current Characteristic;" }, "deviceLib_ResourceCreateEventPayload": { "type": "object", "properties": { "resource": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_Resource" } ], "description": "The involved resource data for the event" } }, "description": "The event data structure" }, "deviceLib_ResourceDeleteEventPayload": { "type": "object", "properties": { "resource": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_Resource" } ], "description": "The involved resource data for the event" } }, "description": "The event data structure" }, "deviceLib_ResourceOperationalStateType": { "type": "string", "enum": [ "enable", "disable" ], "description": "ResourceOperationalStateType enumerations" }, "deviceLib_OutdoorWirelessAntennaDetails": { "type": "object", "properties": { "imei": { "type": "string" }, "make": { "type": "string" }, "model": { "type": "string" }, "serviceId": { "type": "string" }, "serialNumber": { "type": "string" }, "integratedCircuitCardIdentifier": { "type": "string" } }, "description": "Returned for Mode O" }, "deviceLib_ResourceAdministrativeStateType": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ], "description": "ResourceAdministrativeStateType enumerations" }, "deviceLib_ResourceStateChangeEventPayload": { "type": "object", "properties": { "resource": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_Resource" } ], "description": "The involved resource data for the event" } }, "description": "The event data structure" }, "deviceLib_ResourceAttributeValueChangeEvent": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the event." }, "event": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_ResourceAttributeValueChangeEventPayload" } ], "description": "The event payload linked to the involved resource object" }, "domain": { "type": "string", "description": "The domain of the event." }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "priority": { "type": "string", "description": "A priority." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "description": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } }, "description": "The notification data structure" }, "deviceLib_SearchReturnInstallmentPlanDevices": { "type": "object", "properties": { "imei": { "type": "string" }, "msisdn": { "type": "string" }, "occAmount": { "type": "string", "description": "Amount charged to the customer for non compliance" }, "installmentPlanID": { "type": "string", "description": "Customer Installment Plan Identifier or Installment Plan Sequence Number" }, "deviceReturnStatus": { "type": "string", "description": "Device Return status: E- Return expected R- Device returned. N- Device not returned." }, "deviceReturnReason": { "type": "string", "description": "return Reasons only for closed Return DAMAGE- damaged device returned NO-RETURN – Device not returned ERROR – Error record" }, "billingAccountNumber": { "type": "string" }, "deviceReturnCreationDate": { "type": "string", "description": "Device-return entry’s creation date." }, "deviceReturnLastUpdatedDate": { "type": "string", "description": "Device-return entry’s last update date. " } }, "description": "Return for Mode S" }, "deviceLib_ResourceAttributeValueChangeEventPayload": { "type": "object", "properties": { "resource": { "allOf": [ { "$ref": "#/components/schemas/deviceLib_Resource" } ], "description": "The involved resource data for the event" } }, "description": "The event data structure" } }, "headers": {}, "examples": {}, "responses": { "trait_jwt_400": { "description": "JWT Token is required." }, "trait_jwt_401": { "description": "Invalid token." }, "trait_jwt_503": { "description": "Error communicating with JWKS server" }, "trait_ErrorResponses_400": { "content": { "application/json": { "example": { "error": "Bad Request", "status": "Failure", "message": "Required Key not Found" } } }, "description": "The Server will not process the request due to something that is perceived to be a client error(e.x.,malformed request syntax|invalid request message framing|deceptive request routing)." }, "trait_ErrorResponses_401": { "content": { "application/json": { "example": { "error": "Unauthorized", "status": "Failure", "message": "Not Authorized" } } }, "description": "The supplied credentials are not valid." }, "trait_ErrorResponses_403": { "content": { "application/json": { "example": { "error": "Forbidden", "status": "Failure", "message": "Forbidden" } } }, "description": "There is a problem with the credentials that were provided." }, "trait_ErrorResponses_404": { "content": { "application/json": { "example": { "error": "Resource Not Found", "status": "Failure", "message": "Resource not found" } } }, "description": "The server cannot find the requested resource." }, "trait_ErrorResponses_405": { "content": { "application/json": { "example": { "error": "Method Not Allowed", "status": "Failure", "message": "Method not allowed / implemented" } } }, "description": "A request was made of a resource using a request method not supported by that resource;for example(using GET on a form which requires data to be presented via POST(or) using PUT on a read only resource)." }, "trait_ErrorResponses_406": { "content": { "application/json": { "example": { "error": "Not Acceptable", "status": "Failure", "message": "Not Acceptable" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent." }, "trait_ErrorResponses_415": { "content": { "application/json": { "example": { "error": "Unsupported Media Type", "status": "Failure", "message": "Unsupported Media Type" } } }, "description": "The Content-Type specified in the header was unsupported media type." }, "trait_ErrorResponses_500": { "content": { "application/json": { "example": { "error": "Internal Server Error", "status": "Failure", "message": "Internal Server Error" } } }, "description": "An internal processing error occured while processing the API Request." }, "securityScheme_ATT_Azure_AD_JWT_Token_200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "token_type": { "type": "string", "example": "Bearer", "default": "Bearer" }, "expires_in": { "type": "integer", "format": "int32", "example": 3599 }, "access_token": { "type": "string", "example": "xxxxxxxxxx" }, "ext_expires_in": { "type": "integer", "format": "int32", "example": 3599 } }, "description": "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", "properties": { "error": { "type": "string", "example": "unauthorized_client" }, "trace_id": { "type": "string", "example": "xxxxxxx" }, "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": "xxxxxxxxx" }, "error_description": { "type": "string", "example": "AADSTS700016: Application with identifier 'xxxxxxxx' was not found in the directory 'xxxxxxx'. 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: xxxxxxxx\\r\\nCorrelation ID: xxxxxxx\\r\\nTimestamp: 2021-06-30 21:12:34Z" } }, "description": "Only an example of 400 Error body" } } }, "description": "No description provided" } }, "callbacks": {}, "parameters": { "trait_jwt_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "required": true, "description": "JWT Bearer Token. Token URL: https://login.microsoftonline.com/xxxxxxxxx/oauth2/v2.0/token \r\n\r\n See example below.\r\n\r\n curl --location --request POST 'https://login.microsoftonline.com/xxxxxxxx/oauth2/v2.0/token' \r\n --header 'Content-Type: application/x-www-form-urlencoded' \r\n --header 'Cookie: fpc=Aswi39iZZIlGtxxxxxxxxxgOAAAA; 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=xxxxx-xxxxxx' \r\n --data-urlencode 'client_secret=k_xxxxxx__e.xxxxx' \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_x-att-clientId": { "in": "header", "name": "x-att-clientId", "schema": { "type": "string" }, "required": false }, "trait_headers_x-att-correlationId": { "in": "header", "name": "x-att-correlationId", "schema": { "type": "string" }, "required": false }, "trait_headers_x-att-conversationId": { "in": "header", "name": "x-att-conversationId", "schema": { "type": "string" }, "required": false }, "securityScheme_ATT_Azure_AD_JWT_Token_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzxxxxxxxxxG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJfxxxxxxxQssw5c", "required": true, "description": "JWT Bearer Token" } }, "requestBodies": {}, "securitySchemes": { "ATT_Azure_AD_JWT_Token": { "type": "oauth2", "flows": { "authorizationCode": { "scopes": {}, "tokenUrl": "https://login.microsoftonline.com/xxxxxxxxx/oauth2/v2.0/token", "authorizationUrl": "https://login.microsoftonline.com/xxxxxxxxxx/oauth2/v2.0/token" } }, "description": "Get a JWT Token from AT&T's Azure AD" } } } }