{ "info": { "title": "ATT APIs based on TMF640 - Service Activation - ResellerMobileLine", "version": "4.0.0", "description": "Service Activation and Configuration API goal is to provide the ability to activate and configure Service. This API features Monitor pattern allowing to manage service configuration/activation asynchronous request (server side will provide monitor as POST/PATCH response). \n ### TMF640 performs the following Operations on service resource :\n - Retrieve a service or a collection of services depending on filter criteria\n - Partial update of an service\n - Create a service (including default values and creation rules)\n - Delete a service (for administration purposes)\n - Manage notification of events " }, "tags": [], "paths": { "/healthz": { "get": { "summary": "Health Check", "responses": { "200": { "content": { "application/json": { "example": { "message": "Application up and running", "application_name": "tmf640-serviceActivation-ResellerMobileLine" } } }, "description": "Success" } }, "description": "Health Check", "x-page-slug": "healthz" } }, "/service": { "get": { "summary": "Retrieve Service", "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Service" } } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Method Not allowed" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "@type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] }, "description": "Set to ResellerMobileLineService to qualify the type of id in the request." }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string" }, "description": "fields" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string" }, "description": "offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" }, "description": "limit" } ], "x-page-slug": "retrieve-service", "description": "List or find Service objects. (TMF 640)" }, "post": { "summary": "Create Service", "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Service" } } }, "description": "Acknowledgement" }, "400": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Unauthorized" }, "403": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Forbidden" }, "405": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Method Not allowed" }, "409": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Conflict" }, "500": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "@type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] }, "description": "Set to ResellerMobileLineService to qualify the type of id in the request." } ], "x-page-slug": "create-service", "description": "This operation creates a Service entity. (TMF 640)", "operationId": "createService", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Service_Create" }, { "description": "The information regarding the activation." } ] }, "example": { "id": "string", "href": "string", "name": "string", "note": [ { "id": "string", "author": "string", "date": "2024-02-09T02:36:05.221Z", "text": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "state": "feasibilityChecked", "@type": "string", "endDate": "2024-02-09T02:36:05.221Z", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@basetype": "string", "@schemaLocation": "string", "@type": "string" }, "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "category": "string", "isBundle": true, "startDate": "2024-02-09T02:36:05.221Z", "startMode": "string", "@basetype": "string", "hasStarted": true, "isStateful": true, "description": "string", "serviceDate": "string", "serviceType": "string", "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "@schemaLocation": "string", "isServiceEnabled": true, "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@basetype": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "supportingService": [ { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-09T02:36:05.221Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-09T02:36:05.221Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@basetype": "string", "@schemaLocation": "string", "@type": "string" }, "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-09T02:36:05.221Z", "text": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@basetype": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ {} ], "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceRelationship": [ { "relationshipType": "string", "ServiceRelationshipCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "service": { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-09T02:36:05.221Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-09T02:36:05.221Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@basetype": "string", "@schemaLocation": "string", "@type": "string" }, "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-09T02:36:05.221Z", "text": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@basetype": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ {} ], "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "@type": "LogicalResourceSpecification", "version": "string", "@basetype": "ResourceSpecification", "@referredType": "string", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ] } } }, "required": true } } }, "/service/{id}": { "get": { "summary": "Inquire Switch Transaction Status", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_ResellerMobileLineService" }, "example": { "id": "string", "href": "string", "name": "string", "note": [ { "id": "string", "author": "string", "date": "2024-02-16T20:12:06.493Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "mode": "string", "state": "feasibilityChecked", "@type": "string", "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "marketInfo": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "billingMarket": "str", "billingSubMarket": "str", "billingSystemId": "string", "localMarket": "string", "serviceArea": "string", "serviceZipCode": "string" } } ], "action": "string", "userId": "string", "endDate": "2024-02-16T20:12:06.493Z", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "category": "string", "isBundle": true, "userNote": "string", "response": { "code": "string", "reason": "string", "status": "string", "message": "string" }, "startDate": "2024-02-16T20:12:06.493Z", "startMode": "string", "basePlace": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "@baseType": "string", "hasStarted": true, "isStateful": true, "reasonCode": "string", "description": "string", "serviceDate": "string", "serviceType": "string", "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "relatedDealer": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "salesChannel": "string", "code": "string", "secondaryCode": "string" }, "subscriber": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "billingAccountNumber": "12345678", "convertBlueSubscriber": "string", "installmentPlanId": "string", "last4Ssn": "string", "reasonDescription": "string", "subscriberNumber": "string" }, "commission": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "location": "string", "salesRepresentative": "string", "dualCommission": { "creditCheckAgent": "string", "creditCheckAgentLocation": "string" }, "affiliateSalesRepCode": "string", "billingTelephoneNumber": "string", "customerCode": "string" } } ], "switchStatus": "string", "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "commonOrderId": "string", "subReasonCode": "string", "suspendPeriod": "string", "portedInNumber": "string", "@schemaLocation": "string", "isServiceEnabled": true, "baseRelatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "supportingService": [ { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-16T20:12:06.493Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-16T20:12:06.494Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T20:12:06.494Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ { "relationshipType": "string", "ServiceRelationshipCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "service": { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-16T20:12:06.494Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-16T20:12:06.494Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T20:12:06.494Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ {} ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-16T20:12:06.494Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-16T20:12:06.494Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T20:12:06.494Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ {} ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "eligibilityResult": { "reinstatementIndicator": "string", "reinstatementIneligibleCode": "string", "reinstatementIneligibleReason": "string" }, "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "device": { "id": "string", "href": "string", "category": "string", "description": "string", "endOperatingDate": "2024-02-16T20:12:06.494Z", "name": "string", "resourceVersion": "string", "startOperatingDate": "2024-02-16T20:12:06.494Z", "activationFeature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "administrativeState": "locked", "attachment": [ { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "string", "description": "Photograph of the Product", "mimeType": "string", "name": "string", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "string" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T20:12:06.494Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "operationalState": "enable", "place": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "resourceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "resourceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" }, "resourceStatus": "standby", "usageState": "idle", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "deviceDetails": { "imeiType": "string", "firmware": { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "networkActivityDateType": "string", "osType": "string", "osVersion": "string", "softwareVersionNumber": "string" }, "dcapValue": "string", "equipmentType": "string", "esn": "string", "imeiFrequency": "string", "min": "string", "msid": "string", "productType": "string", "smsCapabilityIndicator": "string", "technologyType": "string", "umtsCapacity": "string", "nfcCapabilityIndicator": "string", "imeiVersion": "string", "osVersion": "string", "osType": "string", "lteCapableDeviceFlag": "string", "manufacturer": { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "make": "string", "marketingName": "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" }, "BillingMarket": { "billingMarket": "str", "billingSubMarket": "str", "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" } ], "searchReturnInstallmentPlanDevices": { "billingAccountNumber": "string", "msisdn": "string", "imei": "string", "deviceReturnStatus": "string", "deviceReturnCreationDate": "string", "deviceReturnLastUpdatedDate": "string", "installmentPlanID": "string", "deviceReturnReason": "string", "occAmount": "string" }, "attShippedDeviceDetails": { "transactionStatus": "string", "sku": "string", "deviceShippedStatus": "string" }, "outdoorWirelessAntennaDetails": { "imei": "string", "integratedCircuitCardIdentifier": "string", "serviceId": "string", "make": "string", "model": "string", "serialNumber": "string" }, "imeiNumber1": "string", "imeiNumber2": "string" }, "deviceStatusDetails": { "imeiType": "string", "deviceCategory": "string", "manufacturer": { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "make": "string", "marketingName": "string", "model": "string" }, "blacklistedIndicator": "B", "blacklistStatusDate": "2024-02-16T20:12:06.495Z", "certificationStateIndicator": "string", "dataOnlyIndicator": "string", "imeiItemId": "string", "lteType": "5", "nfcCapability": "string", "umtsCapableIndicator": "string", "volteSupportIndicator": "string", "attCompatibility": "Green", "frequency": "string", "deviceCapabilitiesType": "string", "deviceUnlockDetails": { "deviceUnlockProfile": { "status": "string", "message": "string" }, "statusDescription": "string", "unlockDate": "2024-02-16T20:12:06.495Z" } } }, "sim": { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "sim": "string", "imsi": "string", "overrideParkSimIndicator": "string" }, "msisdn": { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } } ], "serviceOrderNumber": "string", "serviceRelationship": [ { "relationshipType": "string", "ServiceRelationshipCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "service": { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-16T20:12:06.493Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-16T20:12:06.493Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T20:12:06.493Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ { "relationshipType": "string", "ServiceRelationshipCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "service": { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-16T20:12:06.493Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-16T20:12:06.493Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T20:12:06.493Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ {} ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-16T20:12:06.493Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-16T20:12:06.493Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T20:12:06.493Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ {} ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "nciRateCenterFilter": { "npaNxx": "string", "zipCode": "string", "billingMarket": "string" }, "serviceSpecification": { "id": "string", "href": "string", "name": "string", "@type": "LogicalResourceSpecification", "version": "string", "@baseType": "ResourceSpecification", "@referredType": "string", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "baseSupportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "waiveOrCreditActivationFeeIndicator": "string" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Method Not allowed" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "@type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] }, "description": "Set to ResellerMobileLineService to qualify the type of id in the request." }, { "name": "billingSubMarket", "in": "query", "required": false, "schema": { "type": "string", "pattern": "[A-Z0-9]{2,3}$" }, "description": "Billing submarket" }, { "name": "activityCode", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "ACTIVE" ] }, "description": "Activity code" }, { "name": "localMarket", "in": "query", "required": false, "schema": { "type": "string", "pattern": "[A-Z]{2,3}$" }, "description": "Local Market" }, { "name": "billingMarket", "in": "query", "required": false, "schema": { "type": "string", "pattern": "[A-Z]{3}$" }, "description": "Billing market" } ], "x-page-slug": "inquire-switch", "description": "The InquireSwitchTransactionStatus interaction enables the client to verify that the process of provisioning the switch was successful. This Interaction requires the newly activated Subscriber Number and Activity Code as input. This Interaction requires the newly activated Subscriber Number and Activity Code as input and returns the Subscriber Number and Switch Status. (TMF 640)", "operationId": "InquireSwitchTransactionStatus" }, "patch": { "summary": "Update Service", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_ResellerMobileLineService" }, "example": { "id": "string", "href": "string", "name": "string", "note": [ { "id": "string", "author": "string", "date": "2024-02-16T19:55:22.354Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "mode": "string", "state": "feasibilityChecked", "@type": "string", "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "marketInfo": { "role": "string", "billingMarket": "str", "billingSubMarket": "str", "billingSystemId": "string", "localMarket": "string", "serviceArea": "string", "serviceZipCode": "string" } } ], "action": "string", "userId": "string", "endDate": "2024-02-16T19:55:22.354Z", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "category": "string", "isBundle": true, "userNote": "string", "response": { "code": "string", "reason": "string", "status": "string", "message": "string" }, "startDate": "2024-02-16T19:55:22.354Z", "startMode": "string", "basePlace": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "@baseType": "string", "hasStarted": true, "isStateful": true, "reasonCode": "string", "description": "string", "serviceDate": "string", "serviceType": "string", "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "relatedDealer": { "id": "string", "@referredType": "string", "salesChannel": "string", "code": "string", "secondaryCode": "string" }, "subscriber": { "id": "string", "@referredType": "string", "billingAccountNumber": "12345678", "convertBlueSubscriber": "string", "installmentPlanId": "string", "last4Ssn": "string", "reasonDescription": "string", "subscriberNumber": "string" }, "commission": { "id": "string", "@referredType": "string", "location": "string", "salesRepresentative": "string", "dualCommission": { "creditCheckAgent": "string", "creditCheckAgentLocation": "string" }, "affiliateSalesRepCode": "string", "billingTelephoneNumber": "string", "customerCode": "string" } } ], "switchStatus": "string", "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "commonOrderId": "string", "subReasonCode": "string", "suspendPeriod": "string", "portedInNumber": "string", "@schemaLocation": "string", "isServiceEnabled": true, "baseRelatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "supportingService": [ { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-16T19:55:22.354Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-16T19:55:22.354Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T19:55:22.354Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ {} ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "eligibilityResult": { "reinstatementIndicator": "string", "reinstatementIneligibleCode": "string", "reinstatementIneligibleReason": "string" }, "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "device": { "id": "string", "href": "string", "deviceDetails": { "imeiType": "string", "firmware": { "id": "string", "networkActivityDateType": "string", "osType": "string", "osVersion": "string", "softwareVersionNumber": "string" }, "dcapValue": "string", "equipmentType": "string", "esn": "string", "imeiFrequency": "string", "min": "string", "msid": "string", "productType": "string", "smsCapabilityIndicator": "string", "technologyType": "string", "umtsCapacity": "string", "nfcCapabilityIndicator": "string", "imeiVersion": "string", "osVersion": "string", "osType": "string", "lteCapableDeviceFlag": "string", "manufacturer": { "id": "string", "make": "string", "marketingName": "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" }, "BillingMarket": { "billingMarket": "str", "billingSubMarket": "str", "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" } ], "searchReturnInstallmentPlanDevices": { "billingAccountNumber": "string", "msisdn": "string", "imei": "string", "deviceReturnStatus": "E", "deviceReturnCreationDate": "string", "deviceReturnLastUpdatedDate": "string", "installmentPlanID": "string", "deviceReturnReason": "string", "occAmount": "string" }, "attShippedDeviceDetails": { "transactionStatus": "string", "sku": "string", "deviceShippedStatus": "string" }, "outdoorWirelessAntennaDetails": { "imei": "string", "integratedCircuitCardIdentifier": "string", "serviceId": "string", "make": "string", "model": "string", "serialNumber": "string" }, "imeiNumber1": "string", "imeiNumber2": "string" }, "deviceStatusDetails": { "imeiType": "string", "deviceCategory": "string", "manufacturer": { "id": "string", "make": "string", "marketingName": "string", "model": "string" }, "blacklistedIndicator": "B", "blacklistStatusDate": "2024-02-16T19:55:22.355Z", "certificationStateIndicator": "string", "dataOnlyIndicator": "string", "imeiItemId": "string", "lteType": "5", "nfcCapability": "string", "umtsCapableIndicator": "string", "volteSupportIndicator": "string", "attCompatibility": "Green", "frequency": "string", "deviceCapabilitiesType": "string", "deviceUnlockDetails": { "deviceUnlockProfile": { "status": "string", "message": "string" }, "statusDescription": "string", "unlockDate": "2024-02-16T19:55:22.355Z" } } }, "sim": { "id": "string", "sim": "string", "imsi": "string", "overrideParkSimIndicator": "string" }, "msisdn": { "id": "string" } } ], "serviceOrderNumber": "string", "serviceRelationship": [ { "relationshipType": "string", "ServiceRelationshipCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "service": { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-16T19:55:22.354Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-16T19:55:22.354Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T19:55:22.354Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ {} ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "nciRateCenterFilter": { "npaNxx": "string", "zipCode": "string", "billingMarket": "string" }, "serviceSpecification": { "id": "string", "href": "string", "name": "string", "@type": "LogicalResourceSpecification", "version": "string", "@baseType": "ResourceSpecification", "@referredType": "string", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "baseSupportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "waiveOrCreditActivationFeeIndicator": "string" } } }, "description": "Success" }, "400": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Forbidden" }, "405": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Method Not allowed" }, "409": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Conflict" }, "500": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "@type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] }, "description": "Set to ResellerMobileLineService to qualify the type of id in the request." } ], "x-page-slug": "patch-service-id", "description": "This operation partially updates a Service entity. (TMF 640)", "operationId": "patchService", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineService_Update" }, { "description": "The information regarding the activation." } ] }, "example": { "name": "string", "note": [ { "id": "string", "author": "string", "date": "2024-02-16T19:55:08.132Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "mode": "string", "state": "feasibilityChecked", "@type": "string", "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "marketInfo": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "billingMarket": "str", "billingSubMarket": "str", "billingSystemId": "string", "localMarket": "string", "serviceArea": "string", "serviceZipCode": "string" } } ], "userId": "string", "endDate": "2024-02-16T19:55:08.131Z", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "category": "string", "isBundle": true, "userNote": "string", "startDate": "2024-02-16T19:55:08.131Z", "startMode": "string", "basePlace": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "@baseType": "string", "hasStarted": true, "isStateful": true, "reasonCode": "string", "description": "string", "serviceType": "string", "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "relatedDealer": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "salesChannel": "string", "code": "string", "secondaryCode": "string" }, "subscriber": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "billingAccountNumber": "12345678", "convertBlueSubscriber": "string", "installmentPlanId": "string", "last4Ssn": "string", "reasonDescription": "string", "subscriberNumber": "string" }, "commission": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "location": "string", "salesRepresentative": "string", "dualCommission": { "creditCheckAgent": "string", "creditCheckAgentLocation": "string" }, "affiliateSalesRepCode": "string", "billingTelephoneNumber": "string", "customerCode": "string" } } ], "switchStatus": "string", "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "commonOrderId": "string", "subReasonCode": "string", "suspendPeriod": "string", "portedInNumber": "string", "@schemaLocation": "string", "isServiceEnabled": true, "baseRelatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "supportingService": [ { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-16T19:55:08.132Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-16T19:55:08.132Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T19:55:08.132Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ {} ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "eligibilityResult": { "reinstatementIndicator": "string", "reinstatementIneligibleCode": "string", "reinstatementIneligibleReason": "string" }, "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "device": { "id": "string", "href": "string", "category": "string", "description": "string", "endOperatingDate": "2024-02-16T19:55:08.132Z", "name": "string", "resourceVersion": "string", "startOperatingDate": "2024-02-16T19:55:08.132Z", "activationFeature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "administrativeState": "locked", "attachment": [ { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "string", "description": "Photograph of the Product", "mimeType": "string", "name": "string", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "string" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T19:55:08.132Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "operationalState": "enable", "place": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "resourceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "resourceRelationship": [ { "relationshipType": "string", "resource": { "id": "string", "href": "string", "category": "string", "description": "string", "endOperatingDate": "2024-02-16T19:55:08.132Z", "name": "string", "resourceVersion": "string", "startOperatingDate": "2024-02-16T19:55:08.132Z", "activationFeature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "administrativeState": "locked", "attachment": [ { "id": "4aafacbd-11ff-4dc8-b445-305f2215715f", "href": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "attachmentType": "video", "content": "string", "description": "Photograph of the Product", "mimeType": "string", "name": "string", "url": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "size": { "amount": 1, "units": "string" }, "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T19:55:08.132Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "operationalState": "enable", "place": { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "resourceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "resourceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" }, "resourceStatus": "standby", "usageState": "idle", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "resourceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" }, "resourceStatus": "standby", "usageState": "idle", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "deviceDetails": { "imeiType": "string", "firmware": { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "networkActivityDateType": "string", "osType": "string", "osVersion": "string", "softwareVersionNumber": "string" }, "dcapValue": "string", "equipmentType": "string", "esn": "string", "imeiFrequency": "string", "min": "string", "msid": "string", "productType": "string", "smsCapabilityIndicator": "string", "technologyType": "string", "umtsCapacity": "string", "nfcCapabilityIndicator": "string", "imeiVersion": "string", "osVersion": "string", "osType": "string", "lteCapableDeviceFlag": "string", "manufacturer": { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "make": "string", "marketingName": "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" }, "BillingMarket": { "billingMarket": "str", "billingSubMarket": "str", "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" } ], "searchReturnInstallmentPlanDevices": { "billingAccountNumber": "string", "msisdn": "string", "imei": "string", "deviceReturnStatus": "string", "deviceReturnCreationDate": "string", "deviceReturnLastUpdatedDate": "string", "installmentPlanID": "string", "deviceReturnReason": "string", "occAmount": "string" }, "attShippedDeviceDetails": { "transactionStatus": "string", "sku": "string", "deviceShippedStatus": "string" }, "outdoorWirelessAntennaDetails": { "imei": "string", "integratedCircuitCardIdentifier": "string", "serviceId": "string", "make": "string", "model": "string", "serialNumber": "string" }, "imeiNumber1": "string", "imeiNumber2": "string" }, "deviceStatusDetails": { "imeiType": "string", "deviceCategory": "string", "manufacturer": { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "make": "string", "marketingName": "string", "model": "string" }, "blacklistedIndicator": "B", "blacklistStatusDate": "2024-02-16T19:55:08.132Z", "certificationStateIndicator": "string", "dataOnlyIndicator": "string", "imeiItemId": "string", "lteType": "5", "nfcCapability": "string", "umtsCapableIndicator": "string", "volteSupportIndicator": "string", "attCompatibility": "Green", "frequency": "string", "deviceCapabilitiesType": "string", "deviceUnlockDetails": { "deviceUnlockProfile": { "status": "string", "message": "string" }, "statusDescription": "string", "unlockDate": "2024-02-16T19:55:08.132Z" } } }, "sim": { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string", "sim": "string", "imsi": "string", "overrideParkSimIndicator": "string" }, "msisdn": { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } } ], "serviceOrderNumber": "string", "serviceRelationship": [ { "relationshipType": "string", "ServiceRelationshipCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "service": { "id": "string", "href": "string", "category": "string", "description": "string", "endDate": "2024-02-16T19:55:08.132Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceDate": "string", "serviceType": "string", "startDate": "2024-02-16T19:55:08.132Z", "startMode": "string", "feature": [ { "id": "string", "isBundle": true, "isEnabled": true, "name": "string", "constraint": [ { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "featureCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "string", "name": "string", "relationshipType": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "string", "@schemaLocation": "string", "@type": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "note": [ { "id": "string", "author": "string", "date": "2024-02-16T19:55:08.132Z", "text": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "place": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedEntity": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "string", "role": "string", "serviceOrderHref": "string", "serviceOrderId": "string", "itemAction": "add", "@baseType": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "string", "href": "string", "name": "string", "version": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "supportingService": [ {} ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "nciRateCenterFilter": { "npaNxx": "string", "zipCode": "string", "billingMarket": "str" }, "serviceSpecification": { "id": "string", "href": "string", "name": "string", "@type": "LogicalResourceSpecification", "version": "string", "@baseType": "ResourceSpecification", "@referredType": "string", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "serviceCharacteristic": [ { "id": "string", "name": "string", "valueType": "string", "characteristicRelationship": [ { "id": "string", "relationshipType": "string", "@baseType": "string", "@schemaLocation": "string", "@type": "string" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "baseSupportingResource": [ { "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "waiveOrCreditActivationFeeIndicator": "string" } } }, "required": true } }, "delete": { "summary": "Delete Service", "responses": { "204": { "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Method Not allowed" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "@type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] }, "description": "Set to ResellerMobileLineService to qualify the type of id in the request." } ], "x-page-slug": "delete-service", "description": "This operation deletes a Service entity. Attribute selection is enabled for all first level attributes. (TMF 640)", "operationId": "retrieveService" }, "parameters": [ { "in": "path", "required": true, "name": "id", "schema": { "type": "string", "pattern": "\\d{10}$" }, "description": "Identifier of the Resource - msisdn" } ] }, "/service/{id}/resendOTAProfile": { "post": { "summary": "Resend OTA Profile", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_ResendOTAP" }, "example": { "id": "string", "sim": { "id": "string", "sim": "string", "href": "string", "name": "string", "imsi": "string", "@type": "LogicalResourceSpecification", "@basetype": "ResourceSpecification", "@referredType": "string", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "overrideParkSimIndicator": "string" }, "href": "string", "mode": "FULL", "state": "done", "@type": "string", "response": { "code": "string", "reason": "string", "status": "string", "message": "string" }, "@basetype": "string", "serviceRef": { "id": "string", "href": "string", "name": "string", "@type": "LogicalResourceSpecification", "@basetype": "ResourceSpecification", "@referredType": "string", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "operationId": "string", "billingMarket": { "id": "string", "href": "string", "code": "string", "name": "string", "place": [ { "id": "string", "href": "string", "name": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "@type": "string", "status": "string", "calendar": [ { "day": "string", "status": "string", "timeZone": "string", "hourPeriod": [ { "endHour": "string", "startHour": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "@basetype": "string", "description": "string", "localMarket": "string", "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "billingMarket": "string", "@schemaLocation": "string", "siteRelationship": [ { "id": "string", "href": "string", "relationshipType": "string", "role": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@basetype": "string", "@schemaLocation": "string", "@type": "string" }, "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "billingSubMarket": "string" }, "@schemaLocation": "string", "wirelessLoopIndicator": true } } }, "description": "Created" }, "400": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Unauthorized" }, "403": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Forbidden" }, "405": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Method Not allowed" }, "409": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Conflict" }, "500": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "@type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] }, "description": "Set to ResellerMobileLineService to qualify the type of id in the request." } ], "x-page-slug": "resend-ota", "description": "This operation creates a ResendOTAP entity. (TMF 640)", "operationId": "createsResendOTAP", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_ResendOTAP_Create" }, { "description": "The Resend OTAP to be created." } ] } } }, "required": true } }, "parameters": [ { "in": "path", "required": true, "name": "id", "schema": { "type": "string", "pattern": "\\d{10}$" }, "description": "Identifier of the Resource - msisdn" } ] }, "/service/{id}/resendSubscriberActivation": { "post": { "summary": "Resend Subscriber Activation", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_ResendSubscriberActivation" }, "example": { "id": "string", "pin": "string", "href": "string", "@type": "string", "state": "done", "response": { "code": "string", "reason": "string", "status": "string", "message": "string" }, "@basetype": "string", "serviceRef": { "id": "string", "href": "string", "name": "string", "@type": "LogicalResourceSpecification", "@basetype": "ResourceSpecification", "@referredType": "string", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json" }, "billingMarket": { "id": "string", "href": "string", "code": "string", "name": "string", "place": [ { "id": "string", "href": "string", "name": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string", "@referredType": "string" } ], "@type": "string", "status": "string", "calendar": [ { "day": "string", "status": "string", "timeZone": "string", "hourPeriod": [ { "endHour": "string", "startHour": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "@basetype": "string", "description": "string", "localMarket": "string", "relatedParty": [ { "id": "string", "href": "string", "name": "string", "role": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" } ], "billingMarket": "string", "@schemaLocation": "string", "siteRelationship": [ { "id": "string", "href": "string", "relationshipType": "string", "role": "string", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@basetype": "string", "@schemaLocation": "string", "@type": "string" }, "@basetype": "string", "@schemaLocation": "string", "@type": "string" } ], "billingSubMarket": "string" }, "subscriberInfo": { "0": "string", "id": "string", "href": "string", "name": "string", "role": "string", "@type": "LogicalResourceSpecification", "userId": "string", "last4Ssn": "string", "userNote": "string", "@basetype": "ResourceSpecification", "reasonCode": "string", "@referredType": "string", "subReasonCode": "string", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "subscriberNumber": "string", "installmentPlanId": "string", "reasonDescription": "string", "billingAccountNumber": "12345678", "convertBlueSubscriber": "string", "waiveOrCreditActivationFeeIndicator": "string" }, "@schemaLocation": "string" } } }, "description": "Created" }, "400": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Unauthorized" }, "403": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Forbidden" }, "405": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Method Not allowed" }, "409": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Conflict" }, "500": { "content": { "application/json;charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_Error" }, { "description": "desc" } ] } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "@type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] }, "description": "Set to ResellerMobileLineService to qualify the type of id in the request." } ], "x-page-slug": "resend-subscriber-activation", "description": "This operation creates a ResendSubscriberActivation entity. (TMF 640)", "operationId": "CreateResendSubscriberActivation", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/lib_ResendSubscriberActivation_Create" }, { "description": "The Resend OTAP to be created." } ] } } }, "required": true } }, "parameters": [ { "in": "path", "required": true, "name": "id", "schema": { "type": "string", "pattern": "\\d{10}$" }, "description": "Type of the Service" } ] } }, "openapi": "3.0.3", "components": { "links": {}, "schemas": { "qp_id": { "type": "string" }, "lib_id": { "type": "string" }, "qp_Sim": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_ResellerMobileLineResourceRefOrValue" }, { "type": "object", "properties": { "sim": { "type": "string" }, "imsi": { "type": "string" }, "overrideParkSimIndicator": { "type": "string" } } } ] }, "lib_Sim": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineResourceRefOrValue" }, { "type": "object", "properties": { "sim": { "type": "string" }, "imsi": { "type": "string" }, "overrideParkSimIndicator": { "type": "string" } } } ] }, "qp_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)" }, "date": { "type": "string", "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 entity 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" } } }, "lib_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)" }, "date": { "type": "string", "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 entity 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" } } }, "qp_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 entity 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" } } }, "qp_Error": { "type": "object", "required": [ "code", "reason", "message", "status", "referenceError", "@basetype", "@schemaLocation", "@type" ], "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" } } }, "qp_limit": { "type": "string" }, "qp_object": { "type": "object" }, "lib_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 entity 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" } } }, "lib_Error": { "type": "object", "required": [ "code", "reason", "message", "status", "referenceError", "@basetype", "@schemaLocation", "@type" ], "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" } } }, "lib_limit": { "type": "string" }, "qp_Msisdn": { "$ref": "#/components/schemas/qp_ResellerMobileLineResourceRefOrValue" }, "qp_fields": { "type": "string" }, "qp_offset": { "type": "string" }, "lib_object": { "type": "object" }, "lib_Msisdn": { "$ref": "#/components/schemas/lib_ResellerMobileLineResourceRefOrValue" }, "lib_fields": { "type": "string" }, "lib_offset": { "type": "string" }, "qp_Feature": { "type": "object", "required": [ "name", "constraint", "featureCharacteristic", "featureRelationship" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the feature." }, "name": { "type": "string", "description": "This is the name for the feature." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "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." }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "constraint": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ConstraintRef" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "featureRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/qp_FeatureRelationship" } }, "featureCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Characteristic" } } } }, "qp_Monitor": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of an instance of the monitor. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" }, "href": { "type": "string", "description": "reference to this monitor" }, "state": { "type": "string", "description": "The Monitor state of the resource. InProgress, InError, Completed" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "request": { "allOf": [ { "$ref": "#/components/schemas/qp_Request" }, { "description": "Represents the request" } ] }, "response": { "allOf": [ { "$ref": "#/components/schemas/qp_Response" }, { "description": "Represents the response" } ] }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "sourceHref": { "type": "string", "description": "The monitored resource href" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_Request": { "type": "object", "required": [ "body", "header" ], "properties": { "to": { "type": "string", "description": "The target of the request, e.g. a URL for an HTTP request" }, "body": { "type": "string", "description": "The body of the request. For example for an HTTP request might contain content of a form ." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "method": { "type": "string", "description": "The protocol of the request, e.g. http" }, "header": { "type": "array", "items": { "$ref": "#/components/schemas/qp_HeaderItem" } }, "@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" } } }, "qp_Service": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the service" }, "href": { "type": "string", "description": "Reference of the service" }, "name": { "type": "string", "description": "Name of the service" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Note" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedPlaceRefOrValue" } }, "state": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceStateType" }, { "description": "The life cycle state of the service, such as designed, reserved, active, etc..." } ] }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "endDate": { "type": "string", "description": "Date when the service ends" }, "feature": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Feature" } }, "category": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)." }, "startDate": { "type": "string", "description": "Date when the service starts" }, "startMode": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "hasStarted": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description": { "type": "string", "description": "Free-text description of the service" }, "serviceDate": { "type": "string", "description": "Date when the service was created (whatever its status)." }, "serviceType": { "type": "string", "description": "Business type of the service" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedParty" } }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedEntityRefOrValue" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed " }, "serviceOrderItem": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedServiceOrderItem" } }, "supportingService": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ServiceRefOrValue" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ResourceRef" } }, "serviceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ServiceRelationship" } }, "serviceSpecification": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceSpecificationRef" }, { "description": "The specification from which this service was instantiated" } ] }, "serviceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Characteristic" } } } }, "lib_Feature": { "type": "object", "required": [ "name", "constraint", "featureCharacteristic", "featureRelationship" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the feature." }, "name": { "type": "string", "description": "This is the name for the feature." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "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." }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "constraint": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ConstraintRef" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "featureRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_FeatureRelationship" } }, "featureCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" } } } }, "lib_Monitor": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of an instance of the monitor. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" }, "href": { "type": "string", "description": "reference to this monitor" }, "state": { "type": "string", "description": "The Monitor state of the resource. InProgress, InError, Completed" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "request": { "allOf": [ { "$ref": "#/components/schemas/lib_Request" }, { "description": "Represents the request" } ] }, "response": { "allOf": [ { "$ref": "#/components/schemas/lib_Response" }, { "description": "Represents the response" } ] }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "sourceHref": { "type": "string", "description": "The monitored resource href" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Request": { "type": "object", "required": [ "body", "header" ], "properties": { "to": { "type": "string", "description": "The target of the request, e.g. a URL for an HTTP request" }, "body": { "type": "string", "description": "The body of the request. For example for an HTTP request might contain content of a form ." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "method": { "type": "string", "description": "The protocol of the request, e.g. http" }, "header": { "type": "array", "items": { "$ref": "#/components/schemas/lib_HeaderItem" } }, "@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" } } }, "lib_Service": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the service" }, "href": { "type": "string", "description": "Reference of the service" }, "name": { "type": "string", "description": "Name of the service" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" } }, "state": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceStateType" }, { "description": "The life cycle state of the service, such as designed, reserved, active, etc..." } ] }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "endDate": { "type": "string", "description": "Date when the service ends" }, "feature": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Feature" } }, "category": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)." }, "startDate": { "type": "string", "description": "Date when the service starts" }, "startMode": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "hasStarted": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description": { "type": "string", "description": "Free-text description of the service" }, "serviceDate": { "type": "string", "description": "Date when the service was created (whatever its status)." }, "serviceType": { "type": "string", "description": "Business type of the service" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" } }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedEntityRefOrValue" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed " }, "serviceOrderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedServiceOrderItem" } }, "supportingService": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ServiceRefOrValue" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResourceRef" } }, "serviceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ServiceRelationship" } }, "serviceSpecification": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceSpecificationRef" }, { "description": "The specification from which this service was instantiated" } ] }, "serviceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" } } } }, "qp_Firmware": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_ResourceRef" }, { "type": "object", "properties": { "networkActivityDateType": { "type": "string" }, "osType": { "type": "string" }, "osVersion": { "type": "string" }, "softwareVersionNumber": { "type": "string" } } } ] }, "qp_PlaceRef": { "type": "object", "required": [ "id" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_Quantity": { "type": "object", "properties": { "units": { "type": "string", "description": "Unit" }, "amount": { "type": "number", "default": 1, "description": "Numeric value in a given unit" } } }, "qp_Resource": { "type": "object", "required": [ "id", "href" ], "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/qp_Note" } }, "place": { "$ref": "#/components/schemas/qp_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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/qp_AttachmentRefOrValue" } }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/qp_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/qp_RelatedParty" } }, "resourceStatus": { "allOf": [ { "$ref": "#/components/schemas/qp_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", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "allOf": [ { "$ref": "#/components/schemas/qp_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/qp_Feature" } }, "startOperatingDate": { "type": "string", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "allOf": [ { "$ref": "#/components/schemas/qp_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/qp_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/qp_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Characteristic" } } } }, "qp_Response": { "type": "object", "required": [ "body", "statusCode", "header" ], "properties": { "body": { "type": "string", "description": "The body of the response. For example for an HTTP response might contain HTML for rendering." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "header": { "type": "array", "items": { "$ref": "#/components/schemas/qp_HeaderItem" } }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "statusCode": { "type": "string", "description": "The status of the response. For example for an HTTP response would be codes such as 200, 400, etc." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Firmware": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ResourceRef" }, { "type": "object", "properties": { "networkActivityDateType": { "type": "string" }, "osType": { "type": "string" }, "osVersion": { "type": "string" }, "softwareVersionNumber": { "type": "string" } } } ] }, "lib_PlaceRef": { "type": "object", "required": [ "id" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Quantity": { "type": "object", "properties": { "units": { "type": "string", "description": "Unit" }, "amount": { "type": "number", "default": 1, "description": "Numeric value in a given unit" } } }, "lib_Resource": { "type": "object", "required": [ "id", "href" ], "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/lib_Note" } }, "place": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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/lib_AttachmentRefOrValue" } }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/lib_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/lib_RelatedParty" } }, "resourceStatus": { "allOf": [ { "$ref": "#/components/schemas/lib_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", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "allOf": [ { "$ref": "#/components/schemas/lib_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/lib_Feature" } }, "startOperatingDate": { "type": "string", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "allOf": [ { "$ref": "#/components/schemas/lib_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/lib_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/lib_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" } } } }, "lib_Response": { "type": "object", "required": [ "body", "statusCode", "header" ], "properties": { "body": { "type": "string", "description": "The body of the response. For example for an HTTP response might contain HTML for rendering." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "header": { "type": "array", "items": { "$ref": "#/components/schemas/lib_HeaderItem" } }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "statusCode": { "type": "string", "description": "The status of the response. For example for an HTTP response would be codes such as 200, 400, etc." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_EntityRef": { "type": "object", "required": [ "id" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_EntityRef": { "type": "object", "required": [ "id" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_Extensible": { "type": "object", "properties": { "@type": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_HeaderItem": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name of the header item, e.g. locale" }, "value": { "type": "string", "description": "The value of the header item, e.g. en-us" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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" } } }, "qp_HourPeriod": { "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "endHour": { "type": "string", "description": "The time when the status ends applying" }, "startHour": { "type": "string", "description": "The time when the status starts applying" }, "@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" } } }, "qp_ResendOTAP": { "type": "object", "required": [ "mode" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "sim": { "allOf": [ { "$ref": "#/components/schemas/qp_Sim" }, { "description": "Reference to the Service that needs to be updated" } ] }, "href": { "type": "string", "description": "Hyperlink reference" }, "mode": { "type": "string", "enum": [ "FULL", "VMOnly" ], "description": "Complete OTA resend or voicemail pilot number update" }, "state": { "allOf": [ { "$ref": "#/components/schemas/qp_TaskStateType" }, { "description": "Tracks the lifecycle status of the migrate request." } ] }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "response": { "$ref": "#/components/schemas/qp_ResponseCode" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "marketInfo": { "allOf": [ { "$ref": "#/components/schemas/qp_ResellerMobileLineServiceMarketInfo" }, { "description": "Reference to the Service that needs to be updated" } ] }, "operationId": { "type": "string", "description": "Transaction ID from backend system" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "wirelessLoopIndicator": { "type": "boolean", "description": "Indicates the degree of healing required" } } }, "qp_ServiceRef": { "type": "object", "required": [ "id" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_TimePeriod": { "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "endDateTime": { "type": "string", "example": "1985-04-12T23:20:50.52Z", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "type": "string", "example": "1985-04-12T23:20:50.52Z", "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Extensible": { "type": "object", "properties": { "@type": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_HeaderItem": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name of the header item, e.g. locale" }, "value": { "type": "string", "description": "The value of the header item, e.g. en-us" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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" } } }, "lib_HourPeriod": { "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "endHour": { "type": "string", "description": "The time when the status ends applying" }, "startHour": { "type": "string", "description": "The time when the status starts applying" }, "@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" } } }, "lib_ResendOTAP": { "type": "object", "required": [ "mode" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "sim": { "allOf": [ { "$ref": "#/components/schemas/lib_Sim" }, { "description": "Reference to the Service that needs to be updated" } ] }, "href": { "type": "string", "description": "Hyperlink reference" }, "mode": { "type": "string", "enum": [ "FULL", "VMOnly" ], "description": "Complete OTA resend or voicemail pilot number update" }, "state": { "allOf": [ { "$ref": "#/components/schemas/lib_TaskStateType" }, { "description": "Tracks the lifecycle status of the migrate request." } ] }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "response": { "$ref": "#/components/schemas/lib_ResponseCode" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "marketInfo": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineServiceMarketInfo" }, { "description": "Reference to the Service that needs to be updated" } ] }, "operationId": { "type": "string", "description": "Transaction ID from backend system" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "wirelessLoopIndicator": { "type": "boolean", "description": "Indicates the degree of healing required" } } }, "lib_ServiceRef": { "type": "object", "required": [ "id" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_TimePeriod": { "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "endDateTime": { "type": "string", "example": "1985-04-12T23:20:50.52Z", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "type": "string", "example": "1985-04-12T23:20:50.52Z", "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_Addressable": { "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 entity 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" } } }, "qp_EntityValue": { "type": "object", "required": [ "href" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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" } } }, "qp_ResourceRef": { "type": "object", "required": [ "id" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Addressable": { "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 entity 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" } } }, "lib_EntityValue": { "type": "object", "required": [ "href" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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" } } }, "lib_ResourceRef": { "type": "object", "required": [ "id" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_Manufacturer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_ResourceRef" }, { "type": "object", "properties": { "make": { "type": "string" }, "marketingName": { "type": "string" }, "model": { "type": "string" } } } ] }, "qp_MobileDevice": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_ResellerMobileLineResourceRefOrValue" }, { "type": "object", "properties": { "deviceDetails": { "$ref": "#/components/schemas/qp_DeviceDetails" }, "deviceStatusDetails": { "$ref": "#/components/schemas/qp_DeviceStatusDetails" } } } ] }, "qp_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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_ResponseCode": { "type": "object", "required": [ "code", "reason", "message", "status" ], "properties": { "code": { "type": "string", "description": "Reason code." }, "reason": { "type": "string", "description": "reason." }, "status": { "type": "string", "description": "Status." }, "message": { "type": "string", "description": "message." } } }, "lib_Manufacturer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ResourceRef" }, { "type": "object", "properties": { "make": { "type": "string" }, "marketingName": { "type": "string" }, "model": { "type": "string" } } } ] }, "lib_MobileDevice": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineResourceRefOrValue" }, { "type": "object", "properties": { "deviceDetails": { "$ref": "#/components/schemas/lib_DeviceDetails" }, "deviceStatusDetails": { "$ref": "#/components/schemas/lib_DeviceStatusDetails" } } } ] }, "lib_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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ResponseCode": { "type": "object", "required": [ "code", "reason", "message", "status" ], "properties": { "code": { "type": "string", "description": "Reason code." }, "reason": { "type": "string", "description": "reason." }, "status": { "type": "string", "description": "Status." }, "message": { "type": "string", "description": "message." } } }, "qp_ConstraintRef": { "type": "object", "required": [ "id", "href" ], "properties": { "id": { "type": "string", "description": "reference id to the target constraint" }, "href": { "type": "string", "description": "Hyperlink reference to the target constraint" }, "name": { "type": "string", "description": "Name given to the constraint" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "version": { "type": "string", "description": "constraint version" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "description": "The (class) type of the referred constraint" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_DeviceDetails": { "type": "object", "properties": { "esn": { "type": "string" }, "min": { "type": "string" }, "sku": { "type": "string", "description": "Stock Keeping Unit" }, "msid": { "type": "string" }, "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" }, "firmware": { "$ref": "#/components/schemas/qp_Firmware" }, "dcapValue": { "type": "string" }, "osVersion": { "type": "string", "description": "Operating System version number. Example '7.0.4 (900305)'" }, "isHotlined": { "type": "string" }, "InquireKey": { "allOf": [ { "$ref": "#/components/schemas/qp_object" }, { "description": "Required for Mode O" } ] }, "sourceType": { "type": "string", "description": "It is require when requested for biller or network imei or both" }, "productType": { "type": "string" }, "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" }, "umtsCapacity": { "type": "string" }, "manufacturer": { "$ref": "#/components/schemas/qp_Manufacturer" }, "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" }, "equipmentType": { "type": "string" }, "imeiFrequency": { "type": "string" }, "isRefurbished": { "type": "string" }, "BillingMarket": { "allOf": [ { "$ref": "#/components/schemas/qp_object" }, { "description": "If mode D or T are sent or imeiTypeDetailsIndicator is True, then this should be populated." } ] }, "technologyType": { "type": "string" }, "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/qp_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/qp_NetworkActivity" } }, "PartnerIdDetails": { "$ref": "#/components/schemas/qp_object" }, "StolenDeviceDetails": { "allOf": [ { "$ref": "#/components/schemas/qp_object" }, { "description": "This applies when mode equal to H." } ] }, "lteCapableDeviceFlag": { "type": "string" }, "smsCapabilityIndicator": { "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/qp_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/qp_OutdoorWirelessAntennaDetails" }, { "description": "Returned for Mode O" } ] }, "searchReturnInstallmentPlanDevices": { "allOf": [ { "$ref": "#/components/schemas/qp_SearchReturnInstallmentPlanDevices" }, { "description": "Returned for Mode S" } ] } } }, "qp_TaskStateType": { "type": "string", "enum": [ "accepted", "terminatedWithError", "inProgress", "done" ], "description": "Possible values for the state of a task" }, "lib_ConstraintRef": { "type": "object", "required": [ "id", "href" ], "properties": { "id": { "type": "string", "description": "reference id to the target constraint" }, "href": { "type": "string", "description": "Hyperlink reference to the target constraint" }, "name": { "type": "string", "description": "Name given to the constraint" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "version": { "type": "string", "description": "constraint version" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "description": "The (class) type of the referred constraint" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_DeviceDetails": { "type": "object", "properties": { "esn": { "type": "string" }, "min": { "type": "string" }, "sku": { "type": "string", "description": "Stock Keeping Unit" }, "msid": { "type": "string" }, "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" }, "firmware": { "$ref": "#/components/schemas/lib_Firmware" }, "dcapValue": { "type": "string" }, "osVersion": { "type": "string", "description": "Operating System version number. Example '7.0.4 (900305)'" }, "isHotlined": { "type": "string" }, "InquireKey": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "Required for Mode O" } ] }, "sourceType": { "type": "string", "description": "It is require when requested for biller or network imei or both" }, "productType": { "type": "string" }, "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" }, "umtsCapacity": { "type": "string" }, "manufacturer": { "$ref": "#/components/schemas/lib_Manufacturer" }, "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" }, "equipmentType": { "type": "string" }, "imeiFrequency": { "type": "string" }, "isRefurbished": { "type": "string" }, "BillingMarket": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "If mode D or T are sent or imeiTypeDetailsIndicator is True, then this should be populated." } ] }, "technologyType": { "type": "string" }, "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/lib_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/lib_NetworkActivity" } }, "PartnerIdDetails": { "$ref": "#/components/schemas/lib_object" }, "StolenDeviceDetails": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "This applies when mode equal to H." } ] }, "lteCapableDeviceFlag": { "type": "string" }, "smsCapabilityIndicator": { "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/lib_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/lib_OutdoorWirelessAntennaDetails" }, { "description": "Returned for Mode O" } ] }, "searchReturnInstallmentPlanDevices": { "allOf": [ { "$ref": "#/components/schemas/lib_SearchReturnInstallmentPlanDevices" }, { "description": "Returned for Mode S" } ] } } }, "lib_TaskStateType": { "type": "string", "enum": [ "accepted", "terminatedWithError", "inProgress", "done" ], "description": "Possible values for the state of a task" }, "qp_CalendarPeriod": { "type": "object", "required": [ "hourPeriod" ], "properties": { "day": { "type": "string", "description": "Day where the calendar status applies (e.g.: monday, mon-to-fri, weekdays, weekend, all week, ...)" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "status": { "type": "string", "description": "Indication of the availability of the site (e.g.: open)" }, "timeZone": { "type": "string", "description": "Indication of the timezone applicable to the calendar information (e.g.: Paris, GMT+1)" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "hourPeriod": { "type": "array", "items": { "$ref": "#/components/schemas/qp_HourPeriod" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_Characteristic": { "type": "object", "required": [ "name", "characteristicRelationship", "value" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "name": { "type": "string", "description": "Name of the characteristic" }, "value": { "allOf": [ { "$ref": "#/components/schemas/qp_object" }, { "description": "The value of the characteristic" } ] }, "@type": { "type": "string", "example": "LogicalResourceSpecification", "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", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "characteristicRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/qp_CharacteristicRelationship" } } } }, "qp_GeographicSite": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "code": { "type": "string", "description": "A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/qp_PlaceRefOrValue" } }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "status": { "type": "string", "description": "The condition of the GeographicSite, such as planned, underConstruction, cancelled, active, inactive, former" }, "calendar": { "type": "array", "items": { "$ref": "#/components/schemas/qp_CalendarPeriod" } }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "description": "Text describing additional information regarding the site" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedParty" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "siteRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/qp_GeographicSiteRelationship" } } } }, "qp_Service_Create": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the service" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Note" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedPlaceRefOrValue" } }, "state": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceStateType" }, { "description": "The life cycle state of the service, such as designed, reserved, active, etc..." } ] }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "endDate": { "type": "string", "description": "Date when the service ends" }, "feature": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Feature" } }, "category": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)." }, "startDate": { "type": "string", "description": "Date when the service starts" }, "startMode": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "hasStarted": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description": { "type": "string", "description": "Free-text description of the service" }, "serviceDate": { "type": "string", "description": "Date when the service was created (whatever its status)." }, "serviceType": { "type": "string", "description": "Business type of the service" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedParty" } }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedEntityRefOrValue" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed" }, "serviceOrderItem": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedServiceOrderItem" } }, "supportingService": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ServiceRefOrValue" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ResourceRef" } }, "serviceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ServiceRelationship" } }, "serviceSpecification": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceSpecificationRef" }, { "description": "The specification from which this service was instantiated" } ] }, "serviceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Characteristic" } } } }, "qp_Service_Update": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the service" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Note" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedPlaceRefOrValue" } }, "state": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceStateType" }, { "description": "The life cycle state of the service, such as designed, reserved, active, etc..." } ] }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "endDate": { "type": "string", "description": "Date when the service ends" }, "feature": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Feature" } }, "category": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)." }, "startDate": { "type": "string", "description": "Date when the service starts" }, "startMode": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "hasStarted": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description": { "type": "string", "description": "Free-text description of the service" }, "serviceType": { "type": "string", "description": "Business type of the service" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedParty" } }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedEntityRefOrValue" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed" }, "serviceOrderItem": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedServiceOrderItem" } }, "supportingService": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ServiceRefOrValue" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ResourceRef" } }, "serviceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ServiceRelationship" } }, "serviceSpecification": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceSpecificationRef" }, { "description": "The specification from which this service was instantiated" } ] }, "serviceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Characteristic" } } } }, "lib_CalendarPeriod": { "type": "object", "required": [ "hourPeriod" ], "properties": { "day": { "type": "string", "description": "Day where the calendar status applies (e.g.: monday, mon-to-fri, weekdays, weekend, all week, ...)" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "status": { "type": "string", "description": "Indication of the availability of the site (e.g.: open)" }, "timeZone": { "type": "string", "description": "Indication of the timezone applicable to the calendar information (e.g.: Paris, GMT+1)" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "hourPeriod": { "type": "array", "items": { "$ref": "#/components/schemas/lib_HourPeriod" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Characteristic": { "type": "object", "required": [ "name", "characteristicRelationship", "value" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "name": { "type": "string", "description": "Name of the characteristic" }, "value": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "The value of the characteristic" } ] }, "@type": { "type": "string", "example": "LogicalResourceSpecification", "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", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "characteristicRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_CharacteristicRelationship" } } } }, "lib_GeographicSite": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "code": { "type": "string", "description": "A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/lib_PlaceRefOrValue" } }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "status": { "type": "string", "description": "The condition of the GeographicSite, such as planned, underConstruction, cancelled, active, inactive, former" }, "calendar": { "type": "array", "items": { "$ref": "#/components/schemas/lib_CalendarPeriod" } }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "description": "Text describing additional information regarding the site" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "siteRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_GeographicSiteRelationship" } } } }, "lib_Service_Create": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the service" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" } }, "state": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceStateType" }, { "description": "The life cycle state of the service, such as designed, reserved, active, etc..." } ] }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "endDate": { "type": "string", "description": "Date when the service ends" }, "feature": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Feature" } }, "category": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)." }, "startDate": { "type": "string", "description": "Date when the service starts" }, "startMode": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "hasStarted": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description": { "type": "string", "description": "Free-text description of the service" }, "serviceDate": { "type": "string", "description": "Date when the service was created (whatever its status)." }, "serviceType": { "type": "string", "description": "Business type of the service" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" } }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedEntityRefOrValue" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed" }, "serviceOrderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedServiceOrderItem" } }, "supportingService": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ServiceRefOrValue" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResourceRef" } }, "serviceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ServiceRelationship" } }, "serviceSpecification": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceSpecificationRef" }, { "description": "The specification from which this service was instantiated" } ] }, "serviceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" } } } }, "lib_Service_Update": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the service" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" } }, "state": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceStateType" }, { "description": "The life cycle state of the service, such as designed, reserved, active, etc..." } ] }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "endDate": { "type": "string", "description": "Date when the service ends" }, "feature": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Feature" } }, "category": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)." }, "startDate": { "type": "string", "description": "Date when the service starts" }, "startMode": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "hasStarted": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description": { "type": "string", "description": "Free-text description of the service" }, "serviceType": { "type": "string", "description": "Business type of the service" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" } }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedEntityRefOrValue" } }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed" }, "serviceOrderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedServiceOrderItem" } }, "supportingService": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ServiceRefOrValue" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResourceRef" } }, "serviceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ServiceRelationship" } }, "serviceSpecification": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceSpecificationRef" }, { "description": "The specification from which this service was instantiated" } ] }, "serviceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" } } } }, "qp_IMEITypeDetails": { "type": "object", "required": [ "itemId", "frequency", "dataOnlyIndicator", "dualModeServiceIndicator", "imeiType", "imeiSubtype", "lteType", "nfcCapability", "umtsType", "deviceCapability", "OverrideIMEIData", "ExceptionData" ], "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": { "allOf": [ { "$ref": "#/components/schemas/qp_object" }, { "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": { "allOf": [ { "$ref": "#/components/schemas/qp_object" }, { "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." } } }, "qp_NetworkActivity": { "type": "object", "required": [ "msisdn", "activityDate" ], "properties": { "msisdn": { "type": "string" }, "activityDate": { "type": "string", "description": "The oldest activation date of the particular IMEI and the PhoneNnumber" } } }, "qp_PlaceRefOrValue": { "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 entity 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" } } }, "qp_AttHlrQuerySpec": { "type": "object", "allOf": [ { "type": "object", "properties": { "hlrIndicator": { "description": "HLR query used to return 3G voice and data subscriber information from the ATT 3G HLRs.", "type": "boolean" }, "hlrId": { "description": "clients may supply if available when querying hlr query.", "type": "string", "maxLength": 100 } }, "required": [ "hlrIndicator", "hlrId" ] } ] }, "qp_AttUdmQuerySpec": { "type": "object", "allOf": [ { "type": "object", "properties": { "epcHssIndicator": { "description": "udmIndicator. is 5G indicator and will be populated only with true, if the tag is not present, it means false. To populate this field, imsi number has to be passed as well.", "type": "boolean" } }, "required": [ "epcHssIndicator" ] } ] }, "lib_IMEITypeDetails": { "type": "object", "required": [ "itemId", "frequency", "dataOnlyIndicator", "dualModeServiceIndicator", "imeiType", "imeiSubtype", "lteType", "nfcCapability", "umtsType", "deviceCapability", "OverrideIMEIData", "ExceptionData" ], "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": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "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": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "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." } } }, "lib_NetworkActivity": { "type": "object", "required": [ "msisdn", "activityDate" ], "properties": { "msisdn": { "type": "string" }, "activityDate": { "type": "string", "description": "The oldest activation date of the particular IMEI and the PhoneNnumber" } } }, "lib_PlaceRefOrValue": { "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 entity 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" } } }, "lib_AttHlrQuerySpec": { "type": "object", "allOf": [ { "type": "object", "properties": { "hlrIndicator": { "description": "HLR query used to return 3G voice and data subscriber information from the ATT 3G HLRs.", "type": "boolean" }, "hlrId": { "description": "clients may supply if available when querying hlr query.", "type": "string", "maxLength": 100 } }, "required": [ "hlrIndicator", "hlrId" ] } ] }, "lib_AttUdmQuerySpec": { "type": "object", "allOf": [ { "type": "object", "properties": { "epcHssIndicator": { "description": "udmIndicator. is 5G indicator and will be populated only with true, if the tag is not present, it means false. To populate this field, imsi number has to be passed as well.", "type": "boolean" } }, "required": [ "epcHssIndicator" ] } ] }, "qp_ServiceStateType": { "type": "string", "enum": [ "feasibilityChecked", "designed", "reserved", "inactive", "active", "terminated" ], "description": "Valid values for the lifecycle state of the service" }, "lib_ServiceStateType": { "type": "string", "enum": [ "feasibilityChecked", "designed", "reserved", "inactive", "active", "terminated" ], "description": "Valid values for the lifecycle state of the service" }, "qp_MarketServiceArea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_GeographicSite" }, { "type": "object", "properties": { "billingMarket": { "description": "BillingMarket", "type": "string" }, "billingSubMarket": { "description": "BillingSubMarket", "type": "string" }, "localMarket": { "description": "LOcalMarket", "type": "string" } } } ] }, "qp_ResendOTAP_Create": { "type": "object", "required": [ "mode" ], "properties": { "sim": { "allOf": [ { "$ref": "#/components/schemas/qp_Sim" }, { "description": "Reference to the Service that needs to be updated" } ] }, "mode": { "type": "string", "enum": [ "FULL", "VMOnly" ], "description": "Complete OTA resend or voicemail pilot number update" }, "@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" }, "marketInfo": { "allOf": [ { "$ref": "#/components/schemas/qp_ResellerMobileLineServiceMarketInfo" }, { "description": "Reference to the Service that needs to be updated" } ] }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "wirelessLoopIndicator": { "type": "boolean", "description": "Indicates the degree of healing required" } } }, "qp_ServiceRefOrValue": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the service" }, "href": { "type": "string", "description": "Reference of the service" }, "name": { "type": "string", "description": "Name of the service" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Note" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedPlaceRefOrValue" } }, "state": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceStateType" }, { "description": "The life cycle state of the service, such as designed, reserved, active, etc..." } ] }, "@type": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "endDate": { "type": "string", "description": "Date when the service ends" }, "feature": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Feature" } }, "category": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a atomic service (hierachy leaf)." }, "startDate": { "type": "string", "description": "Date when the service starts" }, "startMode": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "hasStarted": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description": { "type": "string", "description": "Free-text description of the service" }, "serviceDate": { "type": "string", "description": "Date when the service was created (whatever its status)." }, "serviceType": { "type": "string", "description": "Business type of the service" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedParty" } }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedEntityRefOrValue" } }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed" }, "serviceOrderItem": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedServiceOrderItem" } }, "supportingService": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ServiceRefOrValue" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ResourceRef" } }, "serviceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ServiceRelationship" } }, "serviceSpecification": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceSpecificationRef" }, { "description": "The specification from which this service was instantiated" } ] }, "serviceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Characteristic" } } } }, "qp_EventSubscription": { "type": "object", "required": [ "id", "callback" ], "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." } } }, "qp_MarketServiceInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "serviceZipCode": { "title": "serviceZipCode", "description": "Zip code used to evaluate billingMarket", "type": "string", "minLength": 5, "maxLength": 5, "pattern": "[0-9]{5}" }, "billingMarket": { "title": "billingMarket", "description": "Used for activation", "type": "string", "maxLength": 3 }, "billingSubMarket": { "title": "billingSubMarket", "description": "Used for activation", "type": "string", "maxLength": 3 }, "localMarket": { "title": "localMarket", "type": "string", "maxLength": 3 }, "billingSystemId": { "title": "billingSystemId", "type": "string", "maxLength": 9 }, "storeId": { "title": "storeId", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "type": "string", "maxLength": 10 }, "serviceArea": { "title": "serviceArea", "type": "string", "maxLength": 12 } }, "required": [ "serviceArea" ] } ], "title": "MarketServiceInfo" }, "lib_MarketServiceArea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_GeographicSite" }, { "type": "object", "properties": { "billingMarket": { "description": "BillingMarket", "type": "string" }, "billingSubMarket": { "description": "BillingSubMarket", "type": "string" }, "localMarket": { "description": "LOcalMarket", "type": "string" } } } ] }, "lib_ResendOTAP_Create": { "type": "object", "required": [ "mode" ], "properties": { "sim": { "allOf": [ { "$ref": "#/components/schemas/lib_Sim" }, { "description": "Reference to the Service that needs to be updated" } ] }, "mode": { "type": "string", "enum": [ "FULL", "VMOnly" ], "description": "Complete OTA resend or voicemail pilot number update" }, "@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" }, "marketInfo": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineServiceMarketInfo" }, { "description": "Reference to the Service that needs to be updated" } ] }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "wirelessLoopIndicator": { "type": "boolean", "description": "Indicates the degree of healing required" } } }, "lib_ServiceRefOrValue": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the service" }, "href": { "type": "string", "description": "Reference of the service" }, "name": { "type": "string", "description": "Name of the service" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Note" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" } }, "state": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceStateType" }, { "description": "The life cycle state of the service, such as designed, reserved, active, etc..." } ] }, "@type": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "endDate": { "type": "string", "description": "Date when the service ends" }, "feature": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Feature" } }, "category": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a atomic service (hierachy leaf)." }, "startDate": { "type": "string", "description": "Date when the service starts" }, "startMode": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "hasStarted": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description": { "type": "string", "description": "Free-text description of the service" }, "serviceDate": { "type": "string", "description": "Date when the service was created (whatever its status)." }, "serviceType": { "type": "string", "description": "Business type of the service" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" } }, "relatedEntity": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedEntityRefOrValue" } }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation": { "type": "string", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed" }, "serviceOrderItem": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedServiceOrderItem" } }, "supportingService": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ServiceRefOrValue" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResourceRef" } }, "serviceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ServiceRelationship" } }, "serviceSpecification": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceSpecificationRef" }, { "description": "The specification from which this service was instantiated" } ] }, "serviceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" } } } }, "lib_EventSubscription": { "type": "object", "required": [ "id", "callback" ], "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." } } }, "lib_MarketServiceInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "serviceZipCode": { "title": "serviceZipCode", "description": "Zip code used to evaluate billingMarket", "type": "string", "minLength": 5, "maxLength": 5, "pattern": "[0-9]{5}" }, "billingMarket": { "title": "billingMarket", "description": "Used for activation", "type": "string", "maxLength": 3 }, "billingSubMarket": { "title": "billingSubMarket", "description": "Used for activation", "type": "string", "maxLength": 3 }, "localMarket": { "title": "localMarket", "type": "string", "maxLength": 3 }, "billingSystemId": { "title": "billingSystemId", "type": "string", "maxLength": 9 }, "storeId": { "title": "storeId", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "type": "string", "maxLength": 10 }, "serviceArea": { "title": "serviceArea", "type": "string", "maxLength": 12 } }, "required": [ "serviceArea" ] } ], "title": "MarketServiceInfo" }, "qp_ResourceRefOrValue": { "type": "object", "required": [ "id", "href" ], "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/qp_Note" } }, "place": { "$ref": "#/components/schemas/qp_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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/qp_AttachmentRefOrValue" } }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/qp_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/qp_RelatedParty" } }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "resourceStatus": { "allOf": [ { "$ref": "#/components/schemas/qp_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", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "allOf": [ { "$ref": "#/components/schemas/qp_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/qp_Feature" } }, "startOperatingDate": { "type": "string", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "allOf": [ { "$ref": "#/components/schemas/qp_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/qp_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/qp_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Characteristic" } } } }, "qp_ResourceStatusType": { "type": "string", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ], "description": "ResourceStatusType enumerations" }, "qp_ServiceCreateEvent": { "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceCreateEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "qp_ServiceDeleteEvent": { "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceDeleteEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "qp_MonitorCreateEvent": { "type": "object", "required": [ "event", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred" ], "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/qp_MonitorCreateEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "qp_MonitorDeleteEvent": { "type": "object", "required": [ "event", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred" ], "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/qp_MonitorDeleteEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "qp_AttEpcHssQuerySpec": { "type": "object", "allOf": [ { "type": "object", "properties": { "epcHssIndicator": { "description": "epdHss query used to return 4G LTE data subscriber information from the ATT HSS Enhanced Packet Core.", "type": "boolean" }, "epcHssId": { "description": "clients may supply if available when querying epcHss query.", "type": "string", "maxLength": 100 } }, "required": [ "epcHssIndicator", "epcHssId" ] } ] }, "qp_AttImsHssQuerySpec": { "type": "object", "allOf": [ { "type": "object", "properties": { "epcHssIndicator": { "description": "Applicable to WLL cllients.", "type": "boolean" }, "epcHssId": { "description": "clients may supply if available when querying imsHss query.", "type": "string", "maxLength": 100 } }, "required": [ "epcHssIndicator", "epcHssId" ] } ] }, "lib_ResourceRefOrValue": { "type": "object", "required": [ "id", "href" ], "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/lib_Note" } }, "place": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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/lib_AttachmentRefOrValue" } }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/lib_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/lib_RelatedParty" } }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "resourceStatus": { "allOf": [ { "$ref": "#/components/schemas/lib_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", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "allOf": [ { "$ref": "#/components/schemas/lib_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/lib_Feature" } }, "startOperatingDate": { "type": "string", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "allOf": [ { "$ref": "#/components/schemas/lib_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/lib_ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/lib_ResourceSpecificationRef" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" } } } }, "lib_ResourceStatusType": { "type": "string", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ], "description": "ResourceStatusType enumerations" }, "lib_ServiceCreateEvent": { "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceCreateEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "lib_ServiceDeleteEvent": { "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceDeleteEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "lib_MonitorCreateEvent": { "type": "object", "required": [ "event", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred" ], "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/lib_MonitorCreateEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "lib_MonitorDeleteEvent": { "type": "object", "required": [ "event", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred" ], "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/lib_MonitorDeleteEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "lib_AttEpcHssQuerySpec": { "type": "object", "allOf": [ { "type": "object", "properties": { "epcHssIndicator": { "description": "epdHss query used to return 4G LTE data subscriber information from the ATT HSS Enhanced Packet Core.", "type": "boolean" }, "epcHssId": { "description": "clients may supply if available when querying epcHss query.", "type": "string", "maxLength": 100 } }, "required": [ "epcHssIndicator", "epcHssId" ] } ] }, "lib_AttImsHssQuerySpec": { "type": "object", "allOf": [ { "type": "object", "properties": { "epcHssIndicator": { "description": "Applicable to WLL cllients.", "type": "boolean" }, "epcHssId": { "description": "clients may supply if available when querying imsHss query.", "type": "string", "maxLength": 100 } }, "required": [ "epcHssIndicator", "epcHssId" ] } ] }, "qp_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": { "$ref": "#/components/schemas/qp_Manufacturer" }, "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", "description": "Indicates when the device was reported Blacklisted or UnBlacklisted." }, "deviceUnlockDetails": { "$ref": "#/components/schemas/qp_object" }, "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" } } }, "qp_FeatureRelationship": { "type": "object", "required": [ "name", "relationshipType" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the target feature." }, "name": { "type": "string", "description": "This is the name of the target feature." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/qp_TimePeriod" }, { "description": "The period for which this feature relationship is valid." } ] }, "@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": "This is the type of the feature relationship." } } }, "qp_OrderItemActionType": { "type": "string", "enum": [ "add", "modify", "delete", "noChange" ], "description": "action to be performed on the product" }, "qp_ServiceRelationship": { "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "service": { "$ref": "#/components/schemas/qp_ServiceRefOrValue" }, "@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" }, "ServiceRelationshipCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/qp_Characteristic" } } } }, "lib_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": { "$ref": "#/components/schemas/lib_Manufacturer" }, "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", "description": "Indicates when the device was reported Blacklisted or UnBlacklisted." }, "deviceUnlockDetails": { "$ref": "#/components/schemas/lib_object" }, "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" } } }, "lib_FeatureRelationship": { "type": "object", "required": [ "name", "relationshipType" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the target feature." }, "name": { "type": "string", "description": "This is the name of the target feature." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" }, { "description": "The period for which this feature relationship is valid." } ] }, "@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": "This is the type of the feature relationship." } } }, "lib_OrderItemActionType": { "type": "string", "enum": [ "add", "modify", "delete", "noChange" ], "description": "action to be performed on the product" }, "lib_ServiceRelationship": { "type": "object", "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "service": { "$ref": "#/components/schemas/lib_ServiceRefOrValue" }, "@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" }, "ServiceRelationshipCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/lib_Characteristic" } } } }, "qp_AttachmentRefOrValue": { "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/qp_Quantity" }, { "description": "The size of the attachment." } ] }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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/qp_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" } } }, "qp_ResourceRelationship": { "type": "object", "required": [ "relationshipType", "resource" ], "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "resource": { "$ref": "#/components/schemas/qp_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", "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 (e.g. an option on an already owned mobile access resource) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" } } }, "lib_AttachmentRefOrValue": { "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/lib_Quantity" }, { "description": "The size of the attachment." } ] }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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/lib_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" } } }, "lib_ResourceRelationship": { "type": "object", "required": [ "relationshipType", "resource" ], "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "resource": { "$ref": "#/components/schemas/lib_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", "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 (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" } } }, "qp_RelatedPlaceRefOrValue": { "type": "object", "required": [ "role" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_ResourceUsageStateType": { "type": "string", "enum": [ "idle", "active", "busy" ], "description": "ResourceUsageStateType enumerations" }, "qp_EventSubscriptionInput": { "type": "object", "required": [ "callback" ], "properties": { "query": { "type": "string", "description": "additional data to be passed" }, "callback": { "type": "string", "description": "The callback being registered." } } }, "lib_RelatedPlaceRefOrValue": { "type": "object", "required": [ "role" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ResourceUsageStateType": { "type": "string", "enum": [ "idle", "active", "busy" ], "description": "ResourceUsageStateType enumerations" }, "lib_EventSubscriptionInput": { "type": "object", "required": [ "callback" ], "properties": { "query": { "type": "string", "description": "additional data to be passed" }, "callback": { "type": "string", "description": "The callback being registered." } } }, "qp_ATTShippedDeviceDetails": { "type": "object", "properties": { "sku": { "type": "string", "description": "Returned only if transactionStatus =SUCCESS" }, "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" } } }, "qp_RelatedEntityRefOrValue": { "type": "object", "required": [ "role" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string" }, "@type": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_RelatedServiceOrderItem": { "type": "object", "required": [ "itemId", "serviceOrderId" ], "properties": { "role": { "type": "string", "description": "role of the service order item for this service" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "itemId": { "type": "string", "description": "Identifier of the order item where the service was managed" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "itemAction": { "allOf": [ { "$ref": "#/components/schemas/qp_OrderItemActionType" }, { "description": "Action of the order item for this service" } ] }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "serviceOrderId": { "type": "string", "description": "Unique identifier of a related entity." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "serviceOrderHref": { "type": "string", "description": "Reference of the related entity." } } }, "qp_ServiceSpecificationRef": { "type": "object", "required": [ "id" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "version": { "type": "string", "description": "Service specification version" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_ServiceStateChangeEvent": { "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceStateChangeEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "qp_MonitorStateChangeEvent": { "type": "object", "required": [ "event", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred" ], "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/qp_MonitorStateChangeEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "qp_AttHlrResourceQuerySpec": { "type": "object", "allOf": [ { "type": "object", "properties": { "msisdn": { "description": "MSISDN", "type": "string" }, "imsi": { "description": "imsi", "type": "string" } }, "required": [ "msisdn", "imsi" ] } ] }, "lib_ATTShippedDeviceDetails": { "type": "object", "properties": { "sku": { "type": "string", "description": "Returned only if transactionStatus =SUCCESS" }, "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" } } }, "lib_RelatedEntityRefOrValue": { "type": "object", "required": [ "role" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string" }, "@type": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_RelatedServiceOrderItem": { "type": "object", "required": [ "itemId", "serviceOrderId" ], "properties": { "role": { "type": "string", "description": "role of the service order item for this service" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "itemId": { "type": "string", "description": "Identifier of the order item where the service was managed" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "itemAction": { "allOf": [ { "$ref": "#/components/schemas/lib_OrderItemActionType" }, { "description": "Action of the order item for this service" } ] }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "serviceOrderId": { "type": "string", "description": "Unique identifier of a related entity." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "serviceOrderHref": { "type": "string", "description": "Reference of the related entity." } } }, "lib_ServiceSpecificationRef": { "type": "object", "required": [ "id" ], "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", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "version": { "type": "string", "description": "Service specification version" }, "@basetype": { "type": "string", "example": "ResourceSpecification", "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", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ServiceStateChangeEvent": { "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceStateChangeEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "lib_MonitorStateChangeEvent": { "type": "object", "required": [ "event", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred" ], "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/lib_MonitorStateChangeEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "lib_AttHlrResourceQuerySpec": { "type": "object", "allOf": [ { "type": "object", "properties": { "msisdn": { "description": "MSISDN", "type": "string" }, "imsi": { "description": "imsi", "type": "string" } }, "required": [ "msisdn", "imsi" ] } ] }, "qp_ResourceSpecificationRef": { "type": "object", "required": [ "id", "href" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the resource specification" }, "href": { "type": "string", "description": "Reference of the resource specification" }, "name": { "type": "string", "description": "Name of the requiredResourceSpecification" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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" } } }, "lib_ResourceSpecificationRef": { "type": "object", "required": [ "id", "href" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the resource specification" }, "href": { "type": "string", "description": "Reference of the resource specification" }, "name": { "type": "string", "description": "Name of the requiredResourceSpecification" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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" } } }, "qp_ResellerMobileLineService": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_Service" }, { "type": "object", "properties": { "action": { "type": "string" }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ResellerMobileLineRelatedPlace" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ResellerMobileLineRelatedParty" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ResellerMobileLineResourceRefOrValue" } }, "eligibilityResult": { "$ref": "#/components/schemas/qp_ResellerMobileLineServiceEligibilityResult" }, "commonOrderId": { "type": "string" }, "mode": { "type": "string" }, "serviceOrderNumber": { "type": "string" }, "switchStatus": { "type": "string" }, "reasonCode": { "type": "string" }, "subReasonCode": { "type": "string" }, "waiveOrCreditActivationFeeIndicator": { "type": "string" }, "userNote": { "type": "string" }, "userId": { "type": "string" }, "suspendPeriod": { "type": "string" }, "nciRateCenterFilter": { "$ref": "#/components/schemas/qp_ResellerMobileLineRateCenterFilter" }, "portedInNumber": { "type": "string" }, "response": { "$ref": "#/components/schemas/qp_ResponseCode" } } } ] }, "qp_ServiceCreateEventPayload": { "type": "object", "properties": { "service": { "allOf": [ { "$ref": "#/components/schemas/qp_Service" }, { "description": "The involved resource data for the event" } ] } } }, "qp_ServiceDeleteEventPayload": { "type": "object", "properties": { "service": { "allOf": [ { "$ref": "#/components/schemas/qp_Service" }, { "description": "The involved resource data for the event" } ] } } }, "qp_MonitorCreateEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "allOf": [ { "$ref": "#/components/schemas/qp_Monitor" }, { "description": "The involved resource data for the event" } ] } } }, "qp_MonitorDeleteEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "allOf": [ { "$ref": "#/components/schemas/qp_Monitor" }, { "description": "The involved resource data for the event" } ] } } }, "qp_AttHlrRegistrationService": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_Service" }, { "type": "object", "properties": { "billigMarket": { "$ref": "#/components/schemas/qp_MarketServiceInfo" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/qp_RelatedParty" } } }, "required": [ "billigMarket", "relatedParty" ] } ] }, "lib_ResellerMobileLineService": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_Service" }, { "type": "object", "properties": { "action": { "type": "string" }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerMobileLineRelatedPlace" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerMobileLineRelatedParty" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerMobileLineResourceRefOrValue" } }, "eligibilityResult": { "$ref": "#/components/schemas/lib_ResellerMobileLineServiceEligibilityResult" }, "commonOrderId": { "type": "string" }, "mode": { "type": "string" }, "serviceOrderNumber": { "type": "string" }, "switchStatus": { "type": "string" }, "reasonCode": { "type": "string" }, "subReasonCode": { "type": "string" }, "waiveOrCreditActivationFeeIndicator": { "type": "string" }, "userNote": { "type": "string" }, "userId": { "type": "string" }, "suspendPeriod": { "type": "string" }, "nciRateCenterFilter": { "$ref": "#/components/schemas/lib_ResellerMobileLineRateCenterFilter" }, "portedInNumber": { "type": "string" }, "response": { "$ref": "#/components/schemas/lib_ResponseCode" } } } ] }, "lib_ServiceCreateEventPayload": { "type": "object", "properties": { "service": { "allOf": [ { "$ref": "#/components/schemas/lib_Service" }, { "description": "The involved resource data for the event" } ] } } }, "lib_ServiceDeleteEventPayload": { "type": "object", "properties": { "service": { "allOf": [ { "$ref": "#/components/schemas/lib_Service" }, { "description": "The involved resource data for the event" } ] } } }, "lib_MonitorCreateEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "allOf": [ { "$ref": "#/components/schemas/lib_Monitor" }, { "description": "The involved resource data for the event" } ] } } }, "lib_MonitorDeleteEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "allOf": [ { "$ref": "#/components/schemas/lib_Monitor" }, { "description": "The involved resource data for the event" } ] } } }, "lib_AttHlrRegistrationService": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_Service" }, { "type": "object", "properties": { "billigMarket": { "$ref": "#/components/schemas/lib_MarketServiceInfo" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_RelatedParty" } } }, "required": [ "billigMarket", "relatedParty" ] } ] }, "qp_CharacteristicRelationship": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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" } } }, "qp_GeographicSiteRelationship": { "type": "object", "required": [ "id", "relationshipType" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the related site entity within the server" }, "href": { "type": "string", "description": "Reference of the related geographic site" }, "role": { "type": "string", "description": "Role of the related site in the relationship" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/qp_TimePeriod" }, { "description": "Validity for the relationship" } ] }, "@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": "Type of relationship" } } }, "qp_ResendSubscriberActivation": { "type": "object", "required": [ "subscriberInfo" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "pin": { "type": "string", "description": "Personal Identification Number of the subscriber. Only required for prepaid accounts" }, "href": { "type": "string", "description": "Hyperlink reference" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "state": { "allOf": [ { "$ref": "#/components/schemas/qp_TaskStateType" }, { "description": "Tracks the lifecycle status of the migrate request." } ] }, "response": { "$ref": "#/components/schemas/qp_ResponseCode" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "billingMarket": { "allOf": [ { "$ref": "#/components/schemas/qp_MarketServiceArea" }, { "description": "Reference to the Service that needs to be updated" } ] }, "subscriberInfo": { "allOf": [ { "$ref": "#/components/schemas/qp_ResellerMobileLineServiceSubscriber" }, { "description": "Reference to the Service that needs to be updated" } ] }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_CharacteristicRelationship": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity 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" } } }, "lib_GeographicSiteRelationship": { "type": "object", "required": [ "id", "relationshipType" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the related site entity within the server" }, "href": { "type": "string", "description": "Reference of the related geographic site" }, "role": { "type": "string", "description": "Role of the related site in the relationship" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "validFor": { "allOf": [ { "$ref": "#/components/schemas/lib_TimePeriod" }, { "description": "Validity for the relationship" } ] }, "@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": "Type of relationship" } } }, "lib_ResendSubscriberActivation": { "type": "object", "required": [ "subscriberInfo" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "pin": { "type": "string", "description": "Personal Identification Number of the subscriber. Only required for prepaid accounts" }, "href": { "type": "string", "description": "Hyperlink reference" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "state": { "allOf": [ { "$ref": "#/components/schemas/lib_TaskStateType" }, { "description": "Tracks the lifecycle status of the migrate request." } ] }, "response": { "$ref": "#/components/schemas/lib_ResponseCode" }, "@basetype": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "billingMarket": { "allOf": [ { "$ref": "#/components/schemas/lib_MarketServiceArea" }, { "description": "Reference to the Service that needs to be updated" } ] }, "subscriberInfo": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineServiceSubscriber" }, { "description": "Reference to the Service that needs to be updated" } ] }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_ResourceOperationalStateType": { "type": "string", "enum": [ "enable", "disable" ], "description": "ResourceOperationalStateType enumerations" }, "lib_ResourceOperationalStateType": { "type": "string", "enum": [ "enable", "disable" ], "description": "ResourceOperationalStateType enumerations" }, "qp_OutdoorWirelessAntennaDetails": { "type": "object", "properties": { "imei": { "type": "string" }, "make": { "type": "string" }, "model": { "type": "string" }, "serviceId": { "type": "string" }, "serialNumber": { "type": "string" }, "integratedCircuitCardIdentifier": { "type": "string" } } }, "lib_OutdoorWirelessAntennaDetails": { "type": "object", "properties": { "imei": { "type": "string" }, "make": { "type": "string" }, "model": { "type": "string" }, "serviceId": { "type": "string" }, "serialNumber": { "type": "string" }, "integratedCircuitCardIdentifier": { "type": "string" } } }, "qp_ResellerMobileLineRelatedPlace": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "marketInfo": { "$ref": "#/components/schemas/qp_ResellerMobileLineServiceMarketInfo" } } } ] }, "qp_ResellerMobileLineRelatedParty": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_RelatedParty" }, { "type": "object", "properties": { "relatedDealer": { "$ref": "#/components/schemas/qp_ResellerMobileLineServiceRelatedDealer" }, "subscriber": { "$ref": "#/components/schemas/qp_ResellerMobileLineServiceSubscriber" }, "commission": { "$ref": "#/components/schemas/qp_ResellerMobileLineServiceCommission" } } } ] }, "qp_ServiceStateChangeEventPayload": { "type": "object", "properties": { "service": { "allOf": [ { "$ref": "#/components/schemas/qp_Service" }, { "description": "The involved resource data for the event" } ] } } }, "qp_MonitorStateChangeEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "allOf": [ { "$ref": "#/components/schemas/qp_Monitor" }, { "description": "The involved resource data for the event" } ] } } }, "lib_ResellerMobileLineRelatedPlace": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "marketInfo": { "$ref": "#/components/schemas/lib_ResellerMobileLineServiceMarketInfo" } } } ] }, "lib_ResellerMobileLineRelatedParty": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "relatedDealer": { "$ref": "#/components/schemas/lib_ResellerMobileLineServiceRelatedDealer" }, "subscriber": { "$ref": "#/components/schemas/lib_ResellerMobileLineServiceSubscriber" }, "commission": { "$ref": "#/components/schemas/lib_ResellerMobileLineServiceCommission" } } } ] }, "lib_ServiceStateChangeEventPayload": { "type": "object", "properties": { "service": { "allOf": [ { "$ref": "#/components/schemas/lib_Service" }, { "description": "The involved resource data for the event" } ] } } }, "lib_MonitorStateChangeEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "allOf": [ { "$ref": "#/components/schemas/lib_Monitor" }, { "description": "The involved resource data for the event" } ] } } }, "qp_ResourceAdministrativeStateType": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ], "description": "ResourceAdministrativeStateType enumerations" }, "lib_ResourceAdministrativeStateType": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ], "description": "ResourceAdministrativeStateType enumerations" }, "qp_ResellerMobileLineService_Update": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_Service_Update" }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "UpdateSubscriberStatus", "SwapEquipment" ] }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ResellerMobileLineRelatedPlace" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ResellerMobileLineRelatedParty" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/qp_ResellerMobileLineResourceRefOrValue" } }, "eligibilityResult": { "$ref": "#/components/schemas/qp_ResellerMobileLineServiceEligibilityResult" }, "commonOrderId": { "type": "string" }, "mode": { "type": "string" }, "serviceOrderNumber": { "type": "string" }, "switchStatus": { "type": "string" }, "reasonCode": { "type": "string" }, "subReasonCode": { "type": "string" }, "waiveOrCreditActivationFeeIndicator": { "type": "string" }, "userNote": { "type": "string" }, "userId": { "type": "string" }, "suspendPeriod": { "type": "string" }, "nciRateCenterFilter": { "$ref": "#/components/schemas/qp_ResellerMobileLineRateCenterFilter" }, "portedInNumber": { "type": "string" } } } ] }, "qp_ServiceAttributeValueChangeEvent": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the event." }, "event": { "allOf": [ { "$ref": "#/components/schemas/qp_ServiceAttributeValueChangeEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "qp_MonitorAttributeValueChangeEvent": { "type": "object", "required": [ "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred", "fieldPath", "event" ], "properties": { "title": { "type": "string", "description": "The title of the event." }, "event": { "allOf": [ { "$ref": "#/components/schemas/qp_MonitorAttributeValueChangeEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "lib_ResellerMobileLineService_Update": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_Service_Update" }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "UpdateSubscriberStatus", "SwapEquipment" ] }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerMobileLineRelatedPlace" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerMobileLineRelatedParty" } }, "supportingResource": { "type": "array", "items": { "$ref": "#/components/schemas/lib_ResellerMobileLineResourceRefOrValue" } }, "eligibilityResult": { "$ref": "#/components/schemas/lib_ResellerMobileLineServiceEligibilityResult" }, "commonOrderId": { "type": "string" }, "mode": { "type": "string" }, "serviceOrderNumber": { "type": "string" }, "switchStatus": { "type": "string" }, "reasonCode": { "type": "string" }, "subReasonCode": { "type": "string" }, "waiveOrCreditActivationFeeIndicator": { "type": "string" }, "userNote": { "type": "string" }, "userId": { "type": "string" }, "suspendPeriod": { "type": "string" }, "nciRateCenterFilter": { "$ref": "#/components/schemas/lib_ResellerMobileLineRateCenterFilter" }, "portedInNumber": { "type": "string" } } } ] }, "lib_ServiceAttributeValueChangeEvent": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the event." }, "event": { "allOf": [ { "$ref": "#/components/schemas/lib_ServiceAttributeValueChangeEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "lib_MonitorAttributeValueChangeEvent": { "type": "object", "required": [ "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred", "fieldPath", "event" ], "properties": { "title": { "type": "string", "description": "The title of the event." }, "event": { "allOf": [ { "$ref": "#/components/schemas/lib_MonitorAttributeValueChangeEventPayload" }, { "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", "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", "description": "The time the event occured." }, "correlationId": { "type": "string", "description": "The correlation id for this event." } } }, "qp_ResendSubscriberActivation_Create": { "type": "object", "properties": { "pin": { "type": "string", "description": "Personal Identification Number of the subscriber. Only required for prepaid accounts" }, "@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" }, "productType": { "type": "string", "enum": [ "G" ], "description": "Should always have value of G" }, "billingMarket": { "allOf": [ { "$ref": "#/components/schemas/qp_MarketServiceArea" }, { "description": "Reference to the Service that needs to be updated" } ] }, "subscriberInfo": { "allOf": [ { "$ref": "#/components/schemas/qp_ResellerMobileLineServiceSubscriber" }, { "description": "Reference to the Service that needs to be updated" } ] }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ResendSubscriberActivation_Create": { "type": "object", "properties": { "pin": { "type": "string", "description": "Personal Identification Number of the subscriber. Only required for prepaid accounts" }, "@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" }, "productType": { "type": "string", "enum": [ "G" ], "description": "Should always have value of G" }, "billingMarket": { "allOf": [ { "$ref": "#/components/schemas/lib_MarketServiceArea" }, { "description": "Reference to the Service that needs to be updated" } ] }, "subscriberInfo": { "allOf": [ { "$ref": "#/components/schemas/lib_ResellerMobileLineServiceSubscriber" }, { "description": "Reference to the Service that needs to be updated" } ] }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "qp_ResellerMobileLineRateCenterFilter": { "type": "object", "properties": { "npaNxx": { "type": "string" }, "zipCode": { "type": "string" }, "billingMarket": { "type": "string" } } }, "qp_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 , R, N" }, "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. " } } }, "lib_ResellerMobileLineRateCenterFilter": { "type": "object", "properties": { "npaNxx": { "type": "string" }, "zipCode": { "type": "string" }, "billingMarket": { "type": "string" } } }, "lib_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 , R, N" }, "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. " } } }, "qp_ResellerMobileLineServiceCommission": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_RelatedParty" }, { "type": "object", "properties": { "location": { "type": "string" }, "salesRepresentative": { "type": "string" }, "dualCommission": { "$ref": "#/components/schemas/qp_object" }, "affiliateSalesRepCode": { "type": "string" }, "billingTelephoneNumber": { "type": "string" }, "customerCode": { "type": "string" } } } ] }, "qp_ResellerMobileLineServiceSubscriber": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_RelatedParty" }, { "type": "object", "properties": { "billingAccountNumber": { "type": "string", "pattern": "^([0-9]{8}|[0-9]{9}|[0-9]{12})$" }, "convertBlueSubscriber": { "type": "string" }, "installmentPlanId": { "type": "string" }, "last4Ssn": { "type": "string" }, "reasonDescription": { "type": "string" }, "subscriberNumber": { "type": "string" } } } ] }, "qp_ResellerMobileLineServiceMarketInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "billingMarket": { "type": "string", "maxLength": 3 }, "billingSubMarket": { "type": "string", "maxLength": 3 }, "billingSystemId": { "type": "string" }, "localMarket": { "type": "string" }, "serviceZipCode": { "type": "string" }, "serviceArea": { "type": "string" } } } ] }, "lib_ResellerMobileLineServiceCommission": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "location": { "type": "string" }, "salesRepresentative": { "type": "string" }, "dualCommission": { "$ref": "#/components/schemas/lib_object" }, "affiliateSalesRepCode": { "type": "string" }, "billingTelephoneNumber": { "type": "string" }, "customerCode": { "type": "string" } } } ] }, "lib_ResellerMobileLineServiceSubscriber": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "billingAccountNumber": { "type": "string", "pattern": "^([0-9]{8}|[0-9]{9}|[0-9]{12})$" }, "convertBlueSubscriber": { "type": "string" }, "installmentPlanId": { "type": "string" }, "last4Ssn": { "type": "string" }, "reasonDescription": { "type": "string" }, "subscriberNumber": { "type": "string" } } } ] }, "lib_ResellerMobileLineServiceMarketInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, { "type": "object", "properties": { "billingMarket": { "type": "string", "maxLength": 3 }, "billingSubMarket": { "type": "string", "maxLength": 3 }, "billingSystemId": { "type": "string" }, "localMarket": { "type": "string" }, "serviceZipCode": { "type": "string" }, "serviceArea": { "type": "string" } } } ] }, "qp_ResellerMobileLineResourceRefOrValue": { "$ref": "#/components/schemas/qp_Resource" }, "lib_ResellerMobileLineResourceRefOrValue": { "$ref": "#/components/schemas/lib_Resource" }, "qp_ResellerMobileLineServiceRelatedDealer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/qp_RelatedParty" }, { "type": "object", "properties": { "salesChannel": { "type": "string" }, "code": { "type": "string" }, "secondaryCode": { "type": "string" } } } ] }, "qp_AttHLRRegistrationServiceSpecification": { "type": "object", "required": [ "serviceSpecCharacteristic" ], "properties": { "serviceSpecCharacteristic": { "type": "array", "items": {} } } }, "lib_ResellerMobileLineServiceRelatedDealer": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/lib_RelatedParty" }, { "type": "object", "properties": { "salesChannel": { "type": "string" }, "code": { "type": "string" }, "secondaryCode": { "type": "string" } } } ] }, "lib_AttHLRRegistrationServiceSpecification": { "type": "object", "required": [ "serviceSpecCharacteristic" ], "properties": { "serviceSpecCharacteristic": { "type": "array", "items": {} } } }, "qp_ServiceAttributeValueChangeEventPayload": { "type": "object", "properties": { "service": { "allOf": [ { "$ref": "#/components/schemas/qp_Service" }, { "description": "The involved resource data for the event" } ] } } }, "qp_MonitorAttributeValueChangeEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "allOf": [ { "$ref": "#/components/schemas/qp_Monitor" }, { "description": "The involved resource data for the event" } ] } } }, "lib_ServiceAttributeValueChangeEventPayload": { "type": "object", "properties": { "service": { "allOf": [ { "$ref": "#/components/schemas/lib_Service" }, { "description": "The involved resource data for the event" } ] } } }, "lib_MonitorAttributeValueChangeEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "allOf": [ { "$ref": "#/components/schemas/lib_Monitor" }, { "description": "The involved resource data for the event" } ] } } }, "qp_ResellerMobileLineServiceEligibilityResult": { "type": "object", "properties": { "reinstatementIndicator": { "type": "string" }, "reinstatementIneligibleCode": { "type": "string" }, "reinstatementIneligibleReason": { "type": "string" } } }, "lib_ResellerMobileLineServiceEligibilityResult": { "type": "object", "properties": { "reinstatementIndicator": { "type": "string" }, "reinstatementIneligibleCode": { "type": "string" }, "reinstatementIneligibleReason": { "type": "string" } } } }, "headers": {}, "examples": {}, "responses": { "trait_error-responses_400": { "content": { "application/json": { "example": { "code": "400", "reason": "Required header 'X-ATT-ConversationId' not specified", "status": "400-BAD_REQUEST-TMF622", "message": "Required header 'X-ATT-ConversationId' not specified" } } }, "description": "Bad request to the server." }, "trait_error-responses_401": { "content": { "application/json": { "example": { "code": "401", "reason": "Unauthorized", "status": "401-UNAUTHORIZED-TMF622", "message": "Unauthorized" } } }, "description": "Invalid credentials." }, "trait_error-responses_403": { "content": { "application/json": { "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF622", "message": "Forbidden" } } }, "description": "Issue with the credentials." }, "trait_error-responses_404": { "content": { "application/json": { "example": { "code": "404", "reason": "/productOrder1/", "status": "404-NOT_FOUND-TMF622", "message": "/productOrder1/" } } }, "description": "Requested resource no found." }, "trait_error-responses_405": { "content": { "application/json": { "example": { "code": "405", "reason": "HTTP Method get not allowed for : /productOrder/", "status": "405-METHOD_NOT_ALLOWED-TMF622", "message": "HTTP Method get not allowed for : /productOrder/" } } }, "description": "Requested method not supported." }, "trait_error-responses_406": { "content": { "application/json": { "example": { "code": "406", "error": "Not Acceptable", "reason": "Not Acceptable", "status": "405-UNACCEPTABLE-TMF622" } } }, "description": "Unacceptable request body." }, "trait_error-responses_415": { "content": { "application/json": { "example": { "code": "415", "reason": "Unsupported mediaType", "status": "415-UNSUPPORTED_MEDIA_TYPE-TMF622", "message": "Unsupported mediaType" } } }, "description": "Bad Content-Type header. Unsupported media type." }, "trait_error-responses_500": { "content": { "application/json": { "example": { "code": "500", "reason": "Internal Server Error", "status": "500-INTERNAL SERVER_ERROR-TMF622", "message": "Internal Server Error" } } }, "description": "Processing error for the request." }, "securityScheme_ATT_Azure_AD_JWT_Token_200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "token_type", "expires_in", "ext_expires_in", "access_token" ], "properties": { "token_type": { "type": "string", "example": "Bearer", "default": "Bearer" }, "expires_in": { "type": "integer", "format": "int32", "example": 3599 }, "access_token": { "type": "string", "example": "xxxxxxxxxxxxxxxx" }, "ext_expires_in": { "type": "integer", "format": "int32", "example": 3599 } } } } }, "description": "No description provided" }, "securityScheme_ATT_Azure_AD_JWT_Token_400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "error_description", "error_codes", "timestamp", "trace_id", "correlation_id", "error_uri" ], "properties": { "error": { "type": "string", "example": "unauthorized_client" }, "trace_id": { "type": "string", "example": "xxxx-5ee3-48a4-9774-4143176a6900" }, "timestamp": { "type": "string", "example": "2021-06-30 21:12:34Z" }, "error_uri": { "type": "string", "example": "https://login.microsoftonline.com/error?code=700016" }, "error_codes": { "type": "array", "items": { "type": "integer", "format": "int32", "example": 700016 } }, "correlation_id": { "type": "string", "example": "b57403ef-e775-49f6-b40f-009ba759c301" }, "error_description": { "type": "string", "example": "AADSTS700016: Application with identifier 'xxxxxxxxxxxxxxxxxxxxxxxxx'. 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: xxxxx-5ee3-48a4-9774-4143176a6900\\r\\nCorrelation ID: xxxxx-e775-49f6-b40f-009ba759c301\\r\\nTimestamp: 2021-06-30 21:12:34Z" } } } } }, "description": "No description provided" } }, "callbacks": {}, "parameters": { "trait_headers_Accept": { "in": "header", "name": "Accept", "schema": { "type": "string", "default": "application/json" }, "required": true, "description": "Specifies the media type as \"application/json\"." }, "trait_headers_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "required": true, "description": "Valid JSON Web Token." }, "trait_headers_X-ATT-ClientId": { "in": "header", "name": "X-ATT-ClientId", "schema": { "type": "string" }, "required": false, "description": "A GUID1 derived from the JSON Web Token which represents the ClientId of the API Consumer who initiated the call flow at the Mule Gateway. This is used by downstream APIs to log data about the entity which initiated the call flow." }, "trait_headers_X-ATT-CorrelationId": { "in": "header", "name": "X-ATT-CorrelationId", "schema": { "type": "string" }, "required": false, "description": "A GUID1 provided by the client that typically serves as a reference ID used to correlate client activity with transactions processed by the server. It is generally paired with the X-ATT-ConversationId to help with tracing and observability." }, "securityScheme_ATT_Azure_AD_JWT_Token_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxc", "required": true, "description": "JWT Bearer Token" } }, "requestBodies": {}, "securitySchemes": { "ATT_Azure_AD_JWT_Token": { "type": "oauth2", "flows": { "authorizationCode": { "scopes": {}, "tokenUrl": "https://login.microsoftonline.com/xxxxxxxxxxxxxxxxxxxxx/oauth2/v2.0/token", "authorizationUrl": "https://login.microsoftonline.com/xxxxxxxxxxxxxxxx/oauth2/v2.0/token" } }, "description": "Get a JWT Token from AT&T's Azure AD" } } } }