{ "openapi": "3.0.0", "info": { "title": "ATT APIs based on TMF640 - Service Activation - ResellerMobileLine", "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 ", "version": "1.0.44" }, "paths": { "/healthz": { "get": { "description": "Health Check", "responses": { "200": { "description": "Success", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "example": { "application_name": "tmf640-serviceActivation-ResellerMobileLine", "message": "Application up and running" } } } } } } } }, "/service": { "get": { "operationId": "retrieveService", "description": "List or find Service objects. (TMF 640)", "summary": "List or find Service objects", "tags": [ "service" ], "parameters": [ { "name": "@type", "description": "Set to ResellerMobileLineService to qualify the type of id in the request.", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] } }, { "name": "fields", "description": "fields", "required": false, "in": "query", "schema": { "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } }, { "name": "offset", "description": "offset", "required": false, "in": "query", "schema": { "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } }, { "name": "limit", "description": "limit", "required": false, "in": "query", "schema": { "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } ], "responses": { "200": { "description": "Success", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Service" } } } } }, "400": { "description": "Bad Request", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ATT-Azure-AD-JWT-Token": [] } ] }, "post": { "operationId": "createService", "description": "This operation creates a Service entity. (TMF 640)", "summary": "Creates a Service", "tags": [ "service" ], "parameters": [ { "name": "@type", "description": "Set to ResellerMobileLineService to qualify the type of id in the request.", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "service", "description": "The information regarding the activation.", "example": { "value": { "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": [ { "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", "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-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" } }, "type": "object", "properties": { "isServiceEnabled": { "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", "type": "boolean" }, "serviceSpecification": { "description": "The specification from which this service was instantiated", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "version": { "description": "Service specification version", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "endDate": { "description": "Date when the service ends", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "serviceCharacteristic": { "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*])", "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "state": { "description": "The life cycle state of the service, such as designed, reserved, active, etc...", "enum": [ "feasibilityChecked", "designed", "reserved", "inactive", "active", "terminated" ], "type": "string" }, "startMode": { "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", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "hasStarted": { "description": "If TRUE, this Service has already been started", "type": "boolean" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "serviceDate": { "description": "Date when the service was created (whatever its status).", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "relatedEntity": { "description": "A list of related entity in relationship with this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntityRefOrValue" } }, "startDate": { "description": "Date when the service starts", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "isStateful": { "description": "If TRUE, this Service can be changed without affecting any other services", "type": "boolean" }, "supportingService": { "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRefOrValue" } }, "place": { "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)", "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" } }, "serviceOrderItem": { "description": "A list of service order items related to this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedServiceOrderItem" } }, "serviceType": { "description": "Business type of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "category": { "description": "Is it a customer facing or resource facing service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "note": { "description": "A list of notes made on this service", "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "feature": { "description": "A list of feature associated with this service", "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "serviceRelationship": { "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRelationship" } }, "description": { "description": "Free-text description of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "isBundle": { "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).", "type": "boolean" }, "supportingResource": { "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources", "type": "array", "items": { "$ref": "#/components/schemas/ResourceRef" } } } } } }, "x-amf-mediaType": "application/json" }, "responses": { "201": { "description": "Acknowledgement", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "properties": { "isServiceEnabled": { "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 ", "type": "boolean" }, "serviceSpecification": { "description": "The specification from which this service was instantiated", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "version": { "description": "Service specification version", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "endDate": { "description": "Date when the service ends", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "serviceCharacteristic": { "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*])", "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "href": { "description": "Reference of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "state": { "description": "The life cycle state of the service, such as designed, reserved, active, etc...", "enum": [ "feasibilityChecked", "designed", "reserved", "inactive", "active", "terminated" ], "type": "string" }, "hasStarted": { "description": "If TRUE, this Service has already been started", "type": "boolean" }, "startMode": { "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", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "Unique identifier of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "serviceDate": { "description": "Date when the service was created (whatever its status).", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "relatedEntity": { "description": "A list of related entity in relationship with this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntityRefOrValue" } }, "supportingService": { "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRefOrValue" } }, "startDate": { "description": "Date when the service starts", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "isStateful": { "description": "If TRUE, this Service can be changed without affecting any other services", "type": "boolean" }, "place": { "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)", "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" } }, "serviceOrderItem": { "description": "A list of service order items related to this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedServiceOrderItem" } }, "serviceType": { "description": "Business type of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "category": { "description": "Is it a customer facing or resource facing service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "note": { "description": "A list of notes made on this service", "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "feature": { "description": "A list of feature associated with this service ", "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "serviceRelationship": { "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRelationship" } }, "description": { "description": "Free-text description of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "isBundle": { "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).", "type": "boolean" }, "supportingResource": { "description": "A list of supporting resources SupportingResource Note only Service of type RFS can be associated with Resources", "type": "array", "items": { "$ref": "#/components/schemas/ResourceRef" } } } } } } }, "400": { "description": "Bad Request", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "401": { "description": "Unauthorized", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "403": { "description": "Forbidden", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "405": { "description": "Method Not allowed", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "409": { "description": "Conflict", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "500": { "description": "Internal Server Error", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } } }, "security": [ { "ATT-Azure-AD-JWT-Token": [] } ] } }, "/service/{id}": { "get": { "operationId": "InquireSwitchTransactionStatus", "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 and returns the Subscriber Number and Switch Status. (TMF 640)", "summary": "Retrieves a Switch Status with ID", "tags": [ "service" ], "parameters": [ { "name": "billingSubMarket", "description": "Billing submarket", "required": false, "in": "query", "schema": { "type": "string", "pattern": "^[A-Z0-9]{2,3}$" } }, { "name": "activityCode", "description": "Activity code", "required": true, "in": "query", "schema": { "type": "string", "enum": [ "ACTIVE" ] } }, { "name": "localMarket", "description": "Local Market", "required": false, "in": "query", "schema": { "type": "string", "pattern": "^[A-Z]{2,3}$" } }, { "name": "@type", "description": "Set to ResellerMobileLineService to qualify the type of id in the request.", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] } }, { "name": "billingMarket", "description": "Billing market", "required": false, "in": "query", "schema": { "type": "string", "pattern": "^[A-Z]{3}$" } }, { "name": "id", "description": "Identifier of the Resource - msisdn", "required": true, "in": "path", "schema": { "type": "string", "pattern": "^[2-9]\\d{2}[2-9]\\d{6}$" } } ], "responses": { "200": { "description": "Success", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerMobileLineService" } } } }, "400": { "description": "Bad Request", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ATT-Azure-AD-JWT-Token": [] } ] }, "patch": { "operationId": "patchService", "description": "This operation updates partially a Service entity. (TMF 640)", "summary": "Updates a service", "parameters": [ { "name": "@type", "description": "Set to ResellerMobileLineService to qualify the type of id in the request.", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] } }, { "name": "id", "description": "Identifier of the Resource - msisdn", "required": true, "in": "path", "schema": { "type": "string", "pattern": "^[2-9]\\d{2}[2-9]\\d{6}$" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "service", "description": "The information regarding the activation.", "x-amf-examples": { "ChangeSubscriberNum_withNewNum": { "supportingResource": [ { "@type": "Msisdn", "id": "8039224847", "href": "string" }, { "@type": "MobileDevice", "id": "", "href": "", "deviceDetails": { "productType": "G" } } ], "place": [ { "role": "string", "marketInfo": { "role": "" } } ], "reasonCode": "CR" }, "ChangeSubscriberNum_withPortInNum": { "portedInNumber": "8039224847", "supportingResource": [ { "@type": "MobileDevice", "id": "", "href": "", "deviceDetails": { "productType": "G" } } ], "place": [ { "role": "string", "marketInfo": { "role": "" } } ], "reasonCode": "CR" }, "SwapEquipment": { "value": { "category": "", "description": "", "endDate": "2024-02-15T16:45:43.275Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "", "serviceType": "", "startDate": "2024-02-15T16:45:43.275Z", "startMode": "", "feature": [ { "id": "", "isBundle": true, "isEnabled": true, "name": "", "constraint": [ { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "featureCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "", "name": "", "relationshipType": "", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "", "@schemaLocation": "", "@type": "" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "" } ], "note": [ { "id": "", "author": "", "date": "2024-02-15T16:45:43.275Z", "text": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "basePlace": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "relatedEntity": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "baseRelatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "serviceCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "", "role": "", "serviceOrderHref": "", "serviceOrderId": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "serviceRelationship": [ { "relationshipType": "", "ServiceRelationshipCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "service": { "id": "", "href": "", "category": "", "description": "", "endDate": "2024-02-15T16:45:43.276Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "", "serviceDate": "", "serviceType": "", "startDate": "2024-02-15T16:45:43.276Z", "startMode": "", "feature": [ { "id": "", "isBundle": true, "isEnabled": true, "name": "", "constraint": [ { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "featureCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "", "name": "", "relationshipType": "", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "", "@schemaLocation": "", "@type": "" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "" } ], "note": [ { "id": "", "author": "", "date": "2024-02-15T16:45:43.276Z", "text": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "place": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "relatedEntity": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "serviceCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "", "role": "", "serviceOrderHref": "", "serviceOrderId": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "", "href": "", "name": "", "version": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "", "href": "", "name": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "supportingService": [ {} ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "serviceSpecification": { "id": "", "href": "", "name": "", "version": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" }, "state": "feasibilityChecked", "baseSupportingResource": [ { "id": "", "href": "", "name": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "supportingService": [ { "id": "", "href": "", "category": "", "description": "", "endDate": "2024-02-15T16:45:43.276Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "", "serviceDate": "", "serviceType": "", "startDate": "2024-02-15T16:45:43.276Z", "startMode": "", "feature": [ { "id": "", "isBundle": true, "isEnabled": true, "name": "", "constraint": [ { "id": "", "href": "", "name": "", "version": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "featureCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "featureRelationship": [ { "id": "", "name": "", "relationshipType": "", "validFor": { "endDateTime": "1985-04-12T23:20:50.52Z", "startDateTime": "1985-04-12T23:20:50.52Z", "@baseType": "", "@schemaLocation": "", "@type": "" }, "@baseType": "", "@schemaLocation": "", "@type": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "" } ], "note": [ { "id": "", "author": "", "date": "2024-02-15T16:45:43.276Z", "text": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "place": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "relatedEntity": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "relatedParty": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "serviceCharacteristic": [ { "id": "", "name": "", "valueType": "", "characteristicRelationship": [ { "id": "", "relationshipType": "", "@baseType": "", "@schemaLocation": "", "@type": "" } ], "value": {}, "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification" } ], "serviceOrderItem": [ { "itemId": "", "role": "", "serviceOrderHref": "", "serviceOrderId": "", "@baseType": "", "@schemaLocation": "", "@type": "", "@referredType": "" } ], "serviceRelationship": [ {} ], "serviceSpecification": { "id": "", "href": "", "name": "", "version": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" }, "state": "feasibilityChecked", "supportingResource": [ { "id": "", "href": "", "name": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "supportingService": [ {} ], "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "" } ], "@baseType": "", "@schemaLocation": "", "@type": "", "place": [ { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "", "marketInfo": { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "", "billingMarket": "", "billingSubMarket": "", "billingSystemId": "", "localMarket": "", "serviceZipCode": "12345" } } ], "relatedParty": [ { "id": "", "href": "", "name": "Test Swap", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "", "relatedDealer": { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "", "salesChannel": "RS8", "code": "", "secondaryCode": "" }, "subscriber": { "id": "", "href": "", "name": "", "role": "", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "", "billingAccountNumber": "00000000", "convertBlueSubscriber": "true", "installmentPlanId": "", "last4Ssn": "12345", "reasonDescription": "CUST OWN EQUIPMENT", "subscriberNumber": "2524179103" } } ], "supportingResource": [ { "@type": "Msisdn", "id": "", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@referredType": "string" }, { "@type": "MobileDevice", "id": "123456789012345", "href": "string", "category": "string", "description": "string", "endOperatingDate": "2024-02-16T19:55:08.132Z", "name": "string", "resourceVersion": "string", "startOperatingDate": "2024-02-16T19:55:08.132Z", "deviceDetails": { "technologyType": "LTE", "imeiType": "string", "productType": "C" } }, { "@type": "Sim", "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@referredType": "string", "imsi": "string", "overrideParkSimIndicator": "string" } ], "eligibilityResult": { "reinstatementIndicator": "", "reinstatementIneligibleCode": "", "reinstatementIneligibleReason": "" }, "commonOrderId": "", "serviceOrderNumber": "", "switchStatus": "", "reasonCode": "CUST_OWN_EQU", "subReasonCode": "", "waiveOrCreditActivationFeeIndicator": "", "userNote": "", "userId": "", "suspendPeriod": "" } }, "UpdateSubscriberStatus": { "relatedParty": [ { "subscriber": { "billingAccountNumber": "252417980" } } ], "place": [ { "role": "string", "marketInfo": { "role": "string", "billingMarket": "", "billingSubMarket": "", "billingSystemId": "string", "localMarket": "string", "serviceArea": "string", "serviceZipCode": "string" } } ], "eligibilityResult": { "reinstatementIndicator": "string", "reinstatementIneligibleCode": "string", "reinstatementIneligibleReason": "string" }, "commonOrderId": "string", "mode": "R", "serviceOrderNumber": "string", "switchStatus": "string", "reasonCode": "CR", "subReasonCode": "string", "waiveOrCreditActivationFeeIndicator": "string", "userNote": "string", "userId": "string", "suspendPeriod": "string", "nciRateCenterFilter": { "billingMarket": "str", "npaNxx": "string", "zipCode": "string" }, "portedInNumber": "string", "supportingResource": [ { "@type": "Msisdn", "id": "123456789", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@referredType": "string" }, { "@type": "MobileDevice", "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", "deviceDetails": { "imeiType": "string", "firmware": { "id": "string", "href": "string", "name": "string", "networkActivityDateType": "string", "osType": "string", "osVersion": "string", "softwareVersionNumber": "string" }, "productType": "C" } }, { "@type": "Sim", "id": "string", "href": "string", "name": "string", "@baseType": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@referredType": "string", "sim": "string", "imsi": "string", "overrideParkSimIndicator": "string" } ] }, "ChangeSubscriberNum_withServiceArea": { "portedInNumber": "", "supportingResource": [ { "@type": "MobileDevice", "id": "", "href": "", "deviceDetails": { "productType": "G" } } ], "place": [ { "role": "string", "marketInfo": { "role": "", "serviceArea": "006901001589" } } ], "reasonCode": "CR" }, "Patch_request": { "value": { "category": "string", "description": "string", "endDate": "2024-02-16T19:55:08.131Z", "hasStarted": true, "isBundle": true, "isServiceEnabled": true, "isStateful": true, "name": "string", "serviceType": "string", "startDate": "2024-02-16T19:55:08.131Z", "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" } ], "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" } ], "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" } ], "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" } ], "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-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" } ], "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", "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" } ], "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" } ], "@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", "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" } } ], "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" } } ], "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" } } ], "eligibilityResult": { "reinstatementIndicator": "string", "reinstatementIneligibleCode": "string", "reinstatementIneligibleReason": "string" }, "commonOrderId": "string", "mode": "string", "serviceOrderNumber": "string", "switchStatus": "string", "reasonCode": "string", "subReasonCode": "string", "waiveOrCreditActivationFeeIndicator": "string", "userNote": "string", "userId": "string", "suspendPeriod": "string", "nciRateCenterFilter": { "billingMarket": "str", "npaNxx": "string", "zipCode": "string" }, "portedInNumber": "string" } } }, "type": "object", "properties": { "serviceSpecification": { "description": "The specification from which this service was instantiated", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "version": { "description": "Service specification version", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "isServiceEnabled": { "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", "type": "boolean" }, "serviceCharacteristic": { "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*])", "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "endDate": { "description": "Date when the service ends", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "state": { "description": "The life cycle state of the service, such as designed, reserved, active, etc...", "enum": [ "feasibilityChecked", "designed", "reserved", "inactive", "active", "terminated" ], "type": "string" }, "hasStarted": { "description": "If TRUE, this Service has already been started", "type": "boolean" }, "startMode": { "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", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "action": { "enum": [ "UpdateSubscriberStatus", "SwapEquipment" ], "type": "string" }, "mode": { "$ref": "#/components/schemas/SafeString" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "userNote": { "$ref": "#/components/schemas/SafeString" }, "nciRateCenterFilter": { "$ref": "#/components/schemas/ResellerMobileLineRateCenterFilter" }, "eligibilityResult": { "$ref": "#/components/schemas/ResellerMobileLineServiceEligibilityResult" }, "waiveOrCreditActivationFeeIndicator": { "$ref": "#/components/schemas/SafeString" }, "relatedParty": { "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", "type": "array", "items": { "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", "type": "object", "properties": { "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedDealer": { "$ref": "#/components/schemas/ResellerMobileLineServiceRelatedDealer" }, "commission": { "$ref": "#/components/schemas/ResellerMobileLineServiceCommission" }, "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "description": "Role played by the related party", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "subscriber": { "$ref": "#/components/schemas/ResellerMobileLineServiceSubscriber" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } }, "switchStatus": { "$ref": "#/components/schemas/SafeString" }, "subReasonCode": { "$ref": "#/components/schemas/SafeString" }, "relatedEntity": { "description": "A list of related entity in relationship with this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntityRefOrValue" } }, "startDate": { "description": "Date when the service starts", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "isStateful": { "description": "If TRUE, this Service can be changed without affecting any other services", "type": "boolean" }, "supportingService": { "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRefOrValue" } }, "place": { "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)", "type": "array", "items": { "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", "type": "object", "required": [ "role" ], "properties": { "href": { "description": "Unique reference of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "Unique identifier of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "marketInfo": { "$ref": "#/components/schemas/ResellerMobileLineServiceMarketInfo" }, "role": { "$ref": "#/components/schemas/SafeString" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } }, "serviceOrderItem": { "description": "A list of service order items related to this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedServiceOrderItem" } }, "serviceType": { "description": "Business type of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "portedInNumber": { "$ref": "#/components/schemas/SafeString" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "suspendPeriod": { "$ref": "#/components/schemas/SafeString" }, "category": { "description": "Is it a customer facing or resource facing service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "commonOrderId": { "$ref": "#/components/schemas/SafeString" }, "note": { "description": "A list of notes made on this service", "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "feature": { "description": "A list of feature associated with this service", "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "userId": { "$ref": "#/components/schemas/SafeString" }, "serviceRelationship": { "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRelationship" } }, "description": { "description": "Free-text description of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "supportingResource": { "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources", "type": "array", "items": { "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.", "type": "object", "required": [ "href", "id" ], "properties": { "usageState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "idle", "active", "busy" ], "type": "string" }, "href": { "description": "The URI for the object itself.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A string used to give a name to the resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "activationFeature": { "description": "Configuration features", "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRef" }, "id": { "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resourceVersion": { "description": "A field that identifies the specific version of an instance of a resource.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "place": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "administrativeState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "locked", "unlocked", "shutdown" ], "type": "string" }, "resourceStatus": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ], "type": "string" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "category": { "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "endOperatingDate": { "description": "A date time( DateTime). The date till the resource is operating", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "startOperatingDate": { "description": "A date time( DateTime). The date from which the resource is operating", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRelationship" } }, "description": { "description": "free-text description of the resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "operationalState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "enable", "disable" ], "type": "string" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } }, "isBundle": { "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).", "type": "boolean" }, "reasonCode": { "$ref": "#/components/schemas/SafeString" }, "serviceOrderNumber": { "$ref": "#/components/schemas/SafeString" } } } } }, "x-amf-mediaType": "application/json" }, "responses": { "200": { "description": "Success", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ResellerMobileLineService" } } } }, "400": { "description": "Bad Request", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "401": { "description": "Unauthorized", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "403": { "description": "Forbidden", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "405": { "description": "Method Not allowed", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "409": { "description": "Conflict", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "500": { "description": "Internal Server Error", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } } }, "security": [ { "ATT-Azure-AD-JWT-Token": [] } ] }, "delete": { "operationId": "deleteService", "description": "This operation deletes a Service entity. Attribute selection is enabled for all first level attributes. (TMF 640)", "summary": "Deletes a service", "parameters": [ { "name": "@type", "description": "Set to ResellerMobileLineService to qualify the type of id in the request.", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] } }, { "name": "id", "description": "Identifier of the Resource - msisdn", "required": true, "in": "path", "schema": { "type": "string", "pattern": "^[2-9]\\d{2}[2-9]\\d{6}$" } } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not allowed", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ATT-Azure-AD-JWT-Token": [] } ] } }, "/service/{id}/resendOTAProfile": { "post": { "operationId": "createsResendOTAP", "description": "This operation creates a ResendOTAP entity. (TMF 640)", "summary": "Resend OTAP", "tags": [ "service" ], "parameters": [ { "name": "@type", "description": "Set to ResellerMobileLineService to qualify the type of id in the request.", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] } }, { "name": "id", "description": "Identifier of the Resource - msisdn", "required": true, "in": "path", "schema": { "type": "string", "pattern": "^[2-9]\\d{2}[2-9]\\d{6}$" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "service", "description": "The Resend OTAP to be created.", "type": "object", "required": [ "mode" ], "properties": { "sim": { "description": "Reference to the Service that needs to be updated", "type": "object", "required": [ "href", "id" ], "properties": { "sim": { "$ref": "#/components/schemas/SafeString" }, "imsi": { "$ref": "#/components/schemas/SafeString" }, "usageState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "idle", "active", "busy" ], "type": "string" }, "href": { "description": "The URI for the object itself.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A string used to give a name to the resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "activationFeature": { "description": "Configuration features", "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRef" }, "resourceVersion": { "description": "A field that identifies the specific version of an instance of a resource.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "place": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "administrativeState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "locked", "unlocked", "shutdown" ], "type": "string" }, "resourceStatus": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ], "type": "string" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "category": { "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "endOperatingDate": { "description": "A date time( DateTime). The date till the resource is operating", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "startOperatingDate": { "description": "A date time( DateTime). The date from which the resource is operating", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "description": { "description": "free-text description of the resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRelationship" } }, "operationalState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "enable", "disable" ], "type": "string" }, "overrideParkSimIndicator": { "$ref": "#/components/schemas/SafeString" } } }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "wirelessLoopIndicator": { "description": "Indicates the degree of healing required", "type": "boolean" }, "mode": { "description": "Complete OTA resend or voicemail pilot number updation", "enum": [ "FULL", "VMOnly" ], "type": "string" }, "marketInfo": { "description": "Reference to the Service that needs to be updated", "type": "object", "required": [ "role" ], "properties": { "serviceArea": { "$ref": "#/components/schemas/SafeString" }, "serviceZipCode": { "$ref": "#/components/schemas/SafeString" }, "href": { "description": "Unique reference of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "Unique identifier of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "$ref": "#/components/schemas/SafeString" }, "localMarket": { "$ref": "#/components/schemas/SafeString" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingMarket": { "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 3 }, "billingSubMarket": { "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 3 }, "billingSystemId": { "$ref": "#/components/schemas/SafeString" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } }, "x-amf-mediaType": "application/json" }, "responses": { "200": { "description": "Created", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "example": { "id": "string", "href": "string", "response": { "code": "string", "reason": "string", "message": "string", "status": "string" }, "operationId": "string", "mode": "FULL", "wirelessLoopIndicator": true, "serviceRef": { "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": { "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" }, "billingMarket": { "id": "string", "href": "string", "code": "string", "description": "string", "name": "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" } ], "place": [ { "id": "string", "href": "string", "name": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string", "@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" } ], "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" } ], "@basetype": "string", "@schemaLocation": "string", "@type": "string", "billingMarket": "string", "billingSubMarket": "string", "localMarket": "string" }, "state": "done", "@basetype": "string", "@schemaLocation": "string", "@type": "string" }, "type": "object", "required": [ "mode" ], "properties": { "sim": { "description": "Reference to the Service that needs to be updated", "type": "object", "required": [ "href", "id" ], "properties": { "sim": { "$ref": "#/components/schemas/SafeString" }, "imsi": { "$ref": "#/components/schemas/SafeString" }, "usageState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "idle", "active", "busy" ], "type": "string" }, "href": { "description": "The URI for the object itself.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A string used to give a name to the resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "activationFeature": { "description": "Configuration features", "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRef" }, "resourceVersion": { "description": "A field that identifies the specific version of an instance of a resource.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "place": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "administrativeState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "locked", "unlocked", "shutdown" ], "type": "string" }, "resourceStatus": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ], "type": "string" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "category": { "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "endOperatingDate": { "description": "A date time( DateTime). The date till the resource is operating", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "startOperatingDate": { "description": "A date time( DateTime). The date from which the resource is operating", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "description": { "description": "free-text description of the resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRelationship" } }, "operationalState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "enable", "disable" ], "type": "string" }, "overrideParkSimIndicator": { "$ref": "#/components/schemas/SafeString" } } }, "state": { "description": "Tracks the lifecycle status of the migrate request.", "enum": [ "accepted", "terminatedWithError", "inProgress", "done" ], "type": "string" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "response": { "$ref": "#/components/schemas/ResponseCode" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "wirelessLoopIndicator": { "description": "Indicates the degree of healing required", "type": "boolean" }, "mode": { "description": "Complete OTA resend or voicemail pilot number updation", "enum": [ "FULL", "VMOnly" ], "type": "string" }, "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "marketInfo": { "description": "Reference to the Service that needs to be updated", "type": "object", "required": [ "role" ], "properties": { "serviceArea": { "$ref": "#/components/schemas/SafeString" }, "serviceZipCode": { "$ref": "#/components/schemas/SafeString" }, "href": { "description": "Unique reference of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "Unique identifier of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "$ref": "#/components/schemas/SafeString" }, "localMarket": { "$ref": "#/components/schemas/SafeString" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingMarket": { "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 3 }, "billingSubMarket": { "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 3 }, "billingSystemId": { "$ref": "#/components/schemas/SafeString" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "operationId": { "description": "Transaction ID from backend system", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "400": { "description": "Bad Request", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "401": { "description": "Unauthorized", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "403": { "description": "Forbidden", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "405": { "description": "Method Not allowed", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "409": { "description": "Conflict", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "500": { "description": "Internal Server Error", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } } }, "security": [ { "ATT-Azure-AD-JWT-Token": [] } ] } }, "/service/{id}/resendSubscriberActivation": { "post": { "operationId": "CreateResendSubscriberActivation", "description": "This operation creates a ResendSubscriberActivation entity. (TMF 640)", "summary": "ResendSubscriberActivation", "tags": [ "service" ], "parameters": [ { "name": "@type", "description": "Set to ResellerMobileLineService to qualify the type of id in the request.", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] } }, { "name": "id", "description": "Type of the Service", "required": true, "in": "path", "schema": { "type": "string", "pattern": "^[2-9]\\d{2}[2-9]\\d{6}$" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "service", "description": "The Resend OTAP to be created.", "type": "object", "properties": { "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "pin": { "description": "Personal Identification Number of the subscriber. Only required for prepaid accounts", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingMarket": { "description": "Reference to the Service that needs to be updated", "type": "object", "properties": { "siteRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/GeographicSiteRelationship" } }, "href": { "description": "Unique reference of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "Unique identifier of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/PlaceRefOrValue" } }, "localMarket": { "description": "LOcalMarket", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingMarket": { "description": "BillingMarket", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingSubMarket": { "description": "BillingSubMarket", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "description": { "description": "Text describing additional information regarding the site", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "The condition of the GeographicSite, such as planned, underConstruction, cancelled, active, inactive, former", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "calendar": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarPeriod" } } } }, "subscriberInfo": { "description": "Reference to the Service that needs to be updated", "type": "object", "properties": { "last4Ssn": { "$ref": "#/components/schemas/SafeString" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "subscriberNumber": { "$ref": "#/components/schemas/SafeString" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingAccountNumber": { "type": "string", "pattern": "^([0-9]{8}|[0-9]{9}|[0-9]{12})$" }, "convertBlueSubscriber": { "$ref": "#/components/schemas/SafeString" }, "role": { "description": "Role played by the related party", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "reasonDescription": { "$ref": "#/components/schemas/SafeString" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "installmentPlanId": { "$ref": "#/components/schemas/SafeString" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "productType": { "description": "Should always have value of G", "enum": [ "G" ], "type": "string" } } } } }, "x-amf-mediaType": "application/json" }, "responses": { "200": { "description": "Created", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "example": { "id": "string", "href": "string", "response": { "code": "string", "reason": "string", "message": "string", "status": "string" }, "pin": "string", "serviceRef": { "id": "string", "href": "string", "name": "string", "@basetype": "ResourceSpecification", "@schemaLocation": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "@type": "LogicalResourceSpecification", "@referredType": "string" }, "subscriberInfo": { "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", "reasonCode": "string", "reasonDescription": "string", "subReasonCode": "string", "subscriberNumber": "string", "userId": "string", "userNote": "string", "waiveOrCreditActivationFeeIndicator": "string", "": "string" }, "billingMarket": { "id": "string", "href": "string", "code": "string", "description": "string", "name": "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" } ], "place": [ { "id": "string", "href": "string", "name": "string", "@basetype": "string", "@schemaLocation": "string", "@type": "string", "@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" } ], "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" } ], "@basetype": "string", "@schemaLocation": "string", "@type": "string", "billingMarket": "string", "billingSubMarket": "string", "localMarket": "string" }, "@basetype": "string", "@schemaLocation": "string", "@type": "string", "state": "done" }, "type": "object", "required": [ "subscriberInfo" ], "properties": { "state": { "description": "Tracks the lifecycle status of the migrate request.", "enum": [ "accepted", "terminatedWithError", "inProgress", "done" ], "type": "string" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "response": { "$ref": "#/components/schemas/ResponseCode" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "pin": { "description": "Personal Identification Number of the subscriber. Only required for prepaid accounts", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingMarket": { "description": "Reference to the Service that needs to be updated", "type": "object", "properties": { "siteRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/GeographicSiteRelationship" } }, "href": { "description": "Unique reference of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "Unique identifier of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "place": { "type": "array", "items": { "$ref": "#/components/schemas/PlaceRefOrValue" } }, "localMarket": { "description": "LOcalMarket", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingMarket": { "description": "BillingMarket", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingSubMarket": { "description": "BillingSubMarket", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "description": { "description": "Text describing additional information regarding the site", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "The condition of the GeographicSite, such as planned, underConstruction, cancelled, active, inactive, former", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "calendar": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarPeriod" } } } }, "subscriberInfo": { "description": "Reference to the Service that needs to be updated", "type": "object", "properties": { "last4Ssn": { "$ref": "#/components/schemas/SafeString" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "subscriberNumber": { "$ref": "#/components/schemas/SafeString" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingAccountNumber": { "type": "string", "pattern": "^([0-9]{8}|[0-9]{9}|[0-9]{12})$" }, "convertBlueSubscriber": { "$ref": "#/components/schemas/SafeString" }, "role": { "description": "Role played by the related party", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "reasonDescription": { "$ref": "#/components/schemas/SafeString" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "installmentPlanId": { "$ref": "#/components/schemas/SafeString" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } } } }, "400": { "description": "Bad Request", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "401": { "description": "Unauthorized", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "403": { "description": "Forbidden", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "405": { "description": "Method Not allowed", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "409": { "description": "Conflict", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "500": { "description": "Internal Server Error", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } } }, "security": [ { "ATT-Azure-AD-JWT-Token": [] } ] } }, "/service/{id}/updateCallForwardDetails": { "post": { "operationId": "updateCallForwardDetails", "description": "This operation updates call forward details. (TMF 640)", "summary": "Update Call Forward Details", "tags": [ "service" ], "parameters": [ { "name": "@type", "description": "Set to ResellerMobileLineService to qualify the type of id in the request.", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "ResellerMobileLineService" ] } }, { "name": "id", "description": "Identifier of the Resource - msisdn or imsi", "required": true, "in": "path", "schema": { "type": "string", "pattern": "^([0-9]{10}|[0-9]{15})$" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "service", "description": "Updates Call Forward Details.", "example": { "vOLTEIndicator": true, "forwardToSubscriberNumber": "3044763786" }, "type": "object", "required": [ "vOLTEIndicator" ], "properties": { "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "forwardToSubscriberNumber": { "description": "forward to subscriber number", "type": "string", "pattern": "^\\d{10}$" }, "vOLTEIndicator": { "description": "volte indicator", "type": "boolean" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } }, "x-amf-mediaType": "application/json" }, "responses": { "200": { "description": "Created", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "example": { "id": "2159588096", "vOLTEIndicator": true, "forwardToSubscriberNumber": "3044763786", "ResponseCode": { "code": "0", "reason": "", "message": "success", "status": "" } }, "type": "object", "required": [ "vOLTEIndicator", "id" ], "properties": { "response": { "$ref": "#/components/schemas/ResponseCode" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "forwardToSubscriberNumber": { "description": "forward to subscriber number", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "vOLTEIndicator": { "description": "volte indicator", "type": "boolean" }, "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "400": { "description": "Bad Request", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "401": { "description": "Unauthorized", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "403": { "description": "Forbidden", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "405": { "description": "Method Not allowed", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "409": { "description": "Conflict", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "500": { "description": "Internal Server Error", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "desc", "type": "object", "required": [ "reason", "@schemaLocation", "code", "referenceError", "@type", "@basetype", "message", "status" ], "properties": { "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } } }, "security": [ { "ATT-Azure-AD-JWT-Token": [] } ] } } }, "components": { "securitySchemes": { "ATT-Azure-AD-JWT-Token": { "type": "oauth2", "description": "Get a JWT Token from AT&T's Azure AD", "x-amf-describedBy": { "headers": { "Authorization": { "description": "JWT Bearer Token", "type": "string" } }, "responses": { "200": { "body": { "application/json": { "description": "Dummy token below. Real token is much longer with more relevant info", "properties": { "token_type": { "default": "Bearer", "example": "Bearer", "type": "string" }, "expires_in": { "example": 3599, "type": "number", "format": "int" }, "ext_expires_in": { "example": 3599, "type": "number", "format": "int" }, "access_token": { "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "type": "string" } } } } }, "400": { "body": { "application/json": { "description": "Only an example of 400 Error body", "properties": { "error": { "example": "unauthorized_client", "type": "string" }, "error_description": { "example": "AADSTS700016: Application with identifier '6bb2748d-d916-4534-9145-ee8f598d2e01' was not found in the directory 'e741d71c-c6b6-47b0-803c-0f3b32b07556'. This can happen if the application has not been installed by the administrator of the tenant or consented to by any user in the tenant. You may have sent your authentication request to the wrong tenant.\\r\\nTrace ID: b82bea2f-5ee3-48a4-9774-4143176a6900\\r\\nCorrelation ID: b57403ef-e775-49f6-b40f-009ba759c301\\r\\nTimestamp: 2021-06-30 21:12:34Z", "type": "string" }, "error_codes": { "items": { "example": 700016, "type": "number", "format": "int" } }, "timestamp": { "example": "2021-06-30 21:12:34Z", "type": "string" }, "trace_id": { "example": "b82bea2f-5ee3-48a4-9774-4143176a6900", "type": "string" }, "correlation_id": { "example": "b57403ef-e775-49f6-b40f-009ba759c301", "type": "string" }, "error_uri": { "example": "https://login.microsoftonline.com/error?code=700016", "type": "string" } } } } } } }, "x-amf-settings": { "authorizationGrants": [ "client_credentials" ] }, "flows": { "clientCredentials": { "tokenUrl": "https://login.microsoftonline.com/e741d71c-c6b6-47b0-803c-0f3b32b07556/oauth2/v2.0/token", "scopes": { "*": "" } } } } }, "schemas": { "Service": { "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.", "type": "object", "properties": { "id": { "description": "Unique identifier of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Reference of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "category": { "description": "Is it a customer facing or resource facing service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "description": { "description": "Free-text description of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "endDate": { "description": "Date when the service ends", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "hasStarted": { "description": "If TRUE, this Service has already been started", "type": "boolean" }, "isBundle": { "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).", "type": "boolean" }, "isServiceEnabled": { "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 ", "type": "boolean" }, "isStateful": { "description": "If TRUE, this Service can be changed without affecting any other services", "type": "boolean" }, "name": { "description": "Name of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "serviceDate": { "description": "Date when the service was created (whatever its status).", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "serviceType": { "description": "Business type of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "startDate": { "description": "Date when the service starts", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "startMode": { "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", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "feature": { "description": "A list of feature associated with this service ", "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "note": { "description": "A list of notes made on this service", "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "place": { "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)", "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" } }, "relatedEntity": { "description": "A list of related entity in relationship with this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntityRefOrValue" } }, "relatedParty": { "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "serviceCharacteristic": { "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*])", "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "serviceOrderItem": { "description": "A list of service order items related to this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedServiceOrderItem" } }, "serviceRelationship": { "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRelationship" } }, "serviceSpecification": { "description": "The specification from which this service was instantiated", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "version": { "description": "Service specification version", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "state": { "description": "The life cycle state of the service, such as designed, reserved, active, etc...", "enum": [ "feasibilityChecked", "designed", "reserved", "inactive", "active", "terminated" ], "type": "string" }, "supportingResource": { "description": "A list of supporting resources SupportingResource Note only Service of type RFS can be associated with Resources", "type": "array", "items": { "$ref": "#/components/schemas/ResourceRef" } }, "supportingService": { "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRefOrValue" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "Error": { "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)", "type": "object", "required": [ "code", "reason", "message", "status", "referenceError", "@basetype", "@schemaLocation", "@type" ], "properties": { "code": { "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "reason": { "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "Characteristic": { "description": "Describes a given characteristic of an object or entity through a name/value pair.", "type": "object", "required": [ "name", "characteristicRelationship", "value" ], "properties": { "id": { "description": "Unique identifier of the characteristic", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the characteristic", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "valueType": { "description": "Data type of the value of the characteristic", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "characteristicRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicRelationship" } }, "value": { "description": "The value of the characteristic", "type": "object" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "RelatedParty": { "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", "type": "object", "properties": { "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "description": "Role played by the related party", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "RelatedEntityRefOrValue": { "description": "A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Entity and not the RelatedEntityRefOrValue class itself", "type": "object", "required": [ "role" ], "properties": { "id": { "description": "Unique identifier of a related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Reference of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "$ref": "#/components/schemas/SafeString" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ServiceRefOrValue": { "description": "A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Service entity and not the RelatedServiceRefOrValue class itself", "type": "object", "properties": { "id": { "description": "Unique identifier of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Reference of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "category": { "description": "Is it a customer facing or resource facing service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "description": { "description": "Free-text description of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "endDate": { "description": "Date when the service ends", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "hasStarted": { "description": "If TRUE, this Service has already been started", "type": "boolean" }, "isBundle": { "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a atomic service (hierachy leaf).", "type": "boolean" }, "isServiceEnabled": { "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", "type": "boolean" }, "isStateful": { "description": "If TRUE, this Service can be changed without affecting any other services", "type": "boolean" }, "name": { "description": "Name of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "serviceDate": { "description": "Date when the service was created (whatever its status).", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "serviceType": { "description": "Business type of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "startDate": { "description": "Date when the service starts", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "startMode": { "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", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "feature": { "description": "A list of feature associated with this service", "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "note": { "description": "A list of notes made on this service", "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "place": { "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)", "type": "array", "items": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" } }, "relatedEntity": { "description": "A list of related entity in relationship with this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntityRefOrValue" } }, "relatedParty": { "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "serviceCharacteristic": { "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*])", "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "serviceOrderItem": { "description": "A list of service order items related to this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedServiceOrderItem" } }, "serviceRelationship": { "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRelationship" } }, "serviceSpecification": { "description": "The specification from which this service was instantiated", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "version": { "description": "Service specification version", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "state": { "description": "The life cycle state of the service, such as designed, reserved, active, etc...", "enum": [ "feasibilityChecked", "designed", "reserved", "inactive", "active", "terminated" ], "type": "string" }, "supportingResource": { "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources", "type": "array", "items": { "$ref": "#/components/schemas/ResourceRef" } }, "supportingService": { "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRefOrValue" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "RelatedPlaceRefOrValue": { "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", "type": "object", "required": [ "role" ], "properties": { "id": { "description": "Unique identifier of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Unique reference of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "$ref": "#/components/schemas/SafeString" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "RelatedServiceOrderItem": { "description": "RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.", "type": "object", "required": [ "itemId", "serviceOrderId" ], "properties": { "itemId": { "description": "Identifier of the order item where the service was managed", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "description": "role of the service order item for this service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "serviceOrderHref": { "description": "Reference of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "serviceOrderId": { "description": "Unique identifier of a related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "itemAction": { "description": "Action of the order item for this service", "enum": [ "add", "modify", "delete", "noChange" ], "type": "string" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "Note": { "description": "Extra information about a given entity", "type": "object", "properties": { "id": { "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "author": { "description": "Author of the note", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "date": { "description": "Date of the note", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "text": { "description": "Text of the note", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "Feature": { "description": "Configuration feature.", "type": "object", "required": [ "name", "constraint", "featureCharacteristic", "featureRelationship" ], "properties": { "id": { "description": "Unique identifier of the feature.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "isBundle": { "description": "True if this is a feature group. Default is false.", "type": "boolean" }, "isEnabled": { "description": "True if this feature is enabled. Default is true.", "type": "boolean" }, "name": { "description": "This is the name for the feature.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "constraint": { "description": "This is a list of feature constraints.", "type": "array", "items": { "$ref": "#/components/schemas/ConstraintRef" } }, "featureCharacteristic": { "description": "This is a list of Characteristics for a particular feature.", "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Characteristic" } }, "featureRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureRelationship" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ServiceRelationship": { "type": "object", "properties": { "relationshipType": { "$ref": "#/components/schemas/SafeString" }, "ServiceRelationshipCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "service": { "$ref": "#/components/schemas/ServiceRefOrValue" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ResourceRef": { "type": "object", "required": [ "id" ], "properties": { "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ResellerMobileLineService": { "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.", "x-amf-examples": { "example_0": { "value": { "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" } ], "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" } ], "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" } ], "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" } ], "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": [ { "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" } ], "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", "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" } ], "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" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string", "action": "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" } } ], "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" } } ], "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" } } ], "eligibilityResult": { "reinstatementIndicator": "string", "reinstatementIneligibleCode": "string", "reinstatementIneligibleReason": "string" }, "commonOrderId": "string", "mode": "string", "serviceOrderNumber": "string", "switchStatus": "string", "reasonCode": "string", "subReasonCode": "string", "waiveOrCreditActivationFeeIndicator": "string", "userNote": "string", "userId": "string", "suspendPeriod": "string", "nciRateCenterFilter": { "billingMarket": "string", "npaNxx": "string", "zipCode": "string" }, "portedInNumber": "string", "response": { "code": "string", "reason": "string", "message": "string", "status": "string" } } }, "example_1": { "value": { "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" } ], "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" } ], "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" } ], "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" } ], "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-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" } ], "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", "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" } ], "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" } ], "@baseType": "string", "@schemaLocation": "string", "@type": "string", "action": "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" } } ], "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" } } ], "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" } } ], "eligibilityResult": { "reinstatementIndicator": "string", "reinstatementIneligibleCode": "string", "reinstatementIneligibleReason": "string" }, "commonOrderId": "string", "mode": "string", "serviceOrderNumber": "string", "switchStatus": "string", "reasonCode": "string", "subReasonCode": "string", "waiveOrCreditActivationFeeIndicator": "string", "userNote": "string", "userId": "string", "suspendPeriod": "string", "nciRateCenterFilter": { "billingMarket": "string", "npaNxx": "string", "zipCode": "string" }, "portedInNumber": "string", "response": { "code": "string", "reason": "string", "message": "string", "status": "string" } } } }, "type": "object", "properties": { "isServiceEnabled": { "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 ", "type": "boolean" }, "serviceSpecification": { "description": "The specification from which this service was instantiated", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "version": { "description": "Service specification version", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "endDate": { "description": "Date when the service ends", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "serviceCharacteristic": { "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*])", "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "href": { "description": "Reference of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "state": { "description": "The life cycle state of the service, such as designed, reserved, active, etc...", "enum": [ "feasibilityChecked", "designed", "reserved", "inactive", "active", "terminated" ], "type": "string" }, "hasStarted": { "description": "If TRUE, this Service has already been started", "type": "boolean" }, "startMode": { "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", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "response": { "$ref": "#/components/schemas/ResponseCode" }, "action": { "$ref": "#/components/schemas/SafeString" }, "mode": { "$ref": "#/components/schemas/SafeString" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "userNote": { "$ref": "#/components/schemas/SafeString" }, "nciRateCenterFilter": { "$ref": "#/components/schemas/ResellerMobileLineRateCenterFilter" }, "id": { "description": "Unique identifier of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "eligibilityResult": { "$ref": "#/components/schemas/ResellerMobileLineServiceEligibilityResult" }, "serviceDate": { "description": "Date when the service was created (whatever its status).", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "waiveOrCreditActivationFeeIndicator": { "$ref": "#/components/schemas/SafeString" }, "relatedParty": { "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", "type": "array", "items": { "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", "type": "object", "properties": { "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedDealer": { "$ref": "#/components/schemas/ResellerMobileLineServiceRelatedDealer" }, "commission": { "$ref": "#/components/schemas/ResellerMobileLineServiceCommission" }, "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "description": "Role played by the related party", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "subscriber": { "$ref": "#/components/schemas/ResellerMobileLineServiceSubscriber" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } }, "switchStatus": { "$ref": "#/components/schemas/SafeString" }, "subReasonCode": { "$ref": "#/components/schemas/SafeString" }, "relatedEntity": { "description": "A list of related entity in relationship with this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntityRefOrValue" } }, "supportingService": { "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRefOrValue" } }, "startDate": { "description": "Date when the service starts", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "isStateful": { "description": "If TRUE, this Service can be changed without affecting any other services", "type": "boolean" }, "place": { "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)", "type": "array", "items": { "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", "type": "object", "required": [ "role" ], "properties": { "href": { "description": "Unique reference of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "Unique identifier of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "marketInfo": { "$ref": "#/components/schemas/ResellerMobileLineServiceMarketInfo" }, "role": { "$ref": "#/components/schemas/SafeString" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } }, "serviceOrderItem": { "description": "A list of service order items related to this service", "type": "array", "items": { "$ref": "#/components/schemas/RelatedServiceOrderItem" } }, "portedInNumber": { "$ref": "#/components/schemas/SafeString" }, "serviceType": { "description": "Business type of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "suspendPeriod": { "$ref": "#/components/schemas/SafeString" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "commonOrderId": { "$ref": "#/components/schemas/SafeString" }, "category": { "description": "Is it a customer facing or resource facing service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "note": { "description": "A list of notes made on this service", "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "feature": { "description": "A list of feature associated with this service ", "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "userId": { "$ref": "#/components/schemas/SafeString" }, "serviceRelationship": { "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", "type": "array", "items": { "$ref": "#/components/schemas/ServiceRelationship" } }, "description": { "description": "Free-text description of the service", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "isBundle": { "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).", "type": "boolean" }, "supportingResource": { "description": "A list of supporting resources SupportingResource Note only Service of type RFS can be associated with Resources", "type": "array", "items": { "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.", "type": "object", "required": [ "href", "id" ], "properties": { "usageState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "idle", "active", "busy" ], "type": "string" }, "href": { "description": "The URI for the object itself.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A string used to give a name to the resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "activationFeature": { "description": "Configuration features", "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRef" }, "id": { "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resourceVersion": { "description": "A field that identifies the specific version of an instance of a resource.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "place": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "administrativeState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "locked", "unlocked", "shutdown" ], "type": "string" }, "resourceStatus": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ], "type": "string" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "category": { "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "endOperatingDate": { "description": "A date time( DateTime). The date till the resource is operating", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "startOperatingDate": { "description": "A date time( DateTime). The date from which the resource is operating", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRelationship" } }, "description": { "description": "free-text description of the resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "operationalState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "enable", "disable" ], "type": "string" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } }, "reasonCode": { "$ref": "#/components/schemas/SafeString" }, "serviceOrderNumber": { "$ref": "#/components/schemas/SafeString" } } }, "SafeString": { "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "ResellerMobileLineRateCenterFilter": { "type": "object", "properties": { "billingMarket": { "$ref": "#/components/schemas/SafeString" }, "npaNxx": { "$ref": "#/components/schemas/SafeString" }, "zipCode": { "$ref": "#/components/schemas/SafeString" } } }, "ResellerMobileLineServiceEligibilityResult": { "type": "object", "properties": { "reinstatementIndicator": { "$ref": "#/components/schemas/SafeString" }, "reinstatementIneligibleCode": { "$ref": "#/components/schemas/SafeString" }, "reinstatementIneligibleReason": { "$ref": "#/components/schemas/SafeString" } } }, "ResellerMobileLineServiceRelatedDealer": { "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", "type": "object", "properties": { "salesChannel": { "$ref": "#/components/schemas/SafeString" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "$ref": "#/components/schemas/SafeString" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "secondaryCode": { "$ref": "#/components/schemas/SafeString" }, "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "description": "Role played by the related party", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ResellerMobileLineServiceCommission": { "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", "type": "object", "properties": { "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "customerCode": { "$ref": "#/components/schemas/SafeString" }, "affiliateSalesRepCode": { "$ref": "#/components/schemas/SafeString" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "dualCommission": { "type": "object", "properties": { "creditCheckAgent": { "$ref": "#/components/schemas/SafeString" }, "creditCheckAgentLocation": { "$ref": "#/components/schemas/SafeString" } } }, "location": { "$ref": "#/components/schemas/SafeString" }, "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "description": "Role played by the related party", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingTelephoneNumber": { "$ref": "#/components/schemas/SafeString" }, "salesRepresentative": { "$ref": "#/components/schemas/SafeString" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ResellerMobileLineServiceSubscriber": { "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", "type": "object", "properties": { "last4Ssn": { "$ref": "#/components/schemas/SafeString" }, "href": { "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "subscriberNumber": { "$ref": "#/components/schemas/SafeString" }, "name": { "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingAccountNumber": { "type": "string", "pattern": "^([0-9]{8}|[0-9]{9}|[0-9]{12})$" }, "convertBlueSubscriber": { "$ref": "#/components/schemas/SafeString" }, "role": { "description": "Role played by the related party", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "reasonDescription": { "$ref": "#/components/schemas/SafeString" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "installmentPlanId": { "$ref": "#/components/schemas/SafeString" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ResellerMobileLineServiceMarketInfo": { "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", "type": "object", "required": [ "role" ], "properties": { "serviceArea": { "$ref": "#/components/schemas/SafeString" }, "serviceZipCode": { "$ref": "#/components/schemas/SafeString" }, "href": { "description": "Unique reference of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "example": "https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "description": "Unique identifier of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "$ref": "#/components/schemas/SafeString" }, "localMarket": { "$ref": "#/components/schemas/SafeString" }, "@type": { "description": "When sub-classing, this defines the sub-class Extensible name", "example": "LogicalResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "example": "ResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingMarket": { "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 3 }, "billingSubMarket": { "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 3 }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingSystemId": { "$ref": "#/components/schemas/SafeString" } } }, "ResourceSpecificationRef": { "description": "Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.", "type": "object", "required": [ "id", "href" ], "properties": { "id": { "description": "Unique identifier of the resource specification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Reference of the resource specification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name of the requiredResourceSpecification", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "version": { "description": "Resource specification version", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "AttachmentRefOrValue": { "description": "An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and not to AttchmentRefOrValue itself", "type": "object", "properties": { "id": { "description": "Unique identifier for this particular attachment", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "URI for this Attachment", "example": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "attachmentType": { "description": "Attachment type such as video, picture", "example": "video", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "content": { "description": "The actual contents of the attachment object, if embedded, encoded as base64", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "description": { "description": "A narrative text describing the content of the attachment", "example": "Photograph of the Product", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "mimeType": { "description": "Attachment mime type such as extension file for video, picture and document", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "The name of the attachment", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "url": { "description": "Uniform Resource Locator, is a web page address (a subset of URI)", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "size": { "description": "The size of the attachment.", "type": "object", "properties": { "amount": { "description": "Numeric value in a given unit", "default": 1, "type": "number" }, "units": { "description": "Unit", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "validFor": { "description": "The period of time for which the attachment is valid", "type": "object", "properties": { "endDateTime": { "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "startDateTime": { "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end", "example": "1985-04-12T23:20:50.52Z", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ResourceRelationship": { "description": "Linked resources to the one instantiate, such as [bundled] if the resource is a bundle and you want to describe the bundled resources inside this bundle; [reliesOn] if the resource needs another already owned resource to rely on (e.g. an option on an already owned mobile access resource) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", "type": "object", "required": [ "relationshipType", "resource" ], "properties": { "relationshipType": { "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", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resource": { "$ref": "#/components/schemas/ResourceRefOrValue" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ResponseCode": { "description": "A response to a request", "type": "object", "required": [ "code", "reason", "message", "status" ], "properties": { "code": { "description": "Reason code.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "reason": { "description": "reason.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "description": "message.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "Status.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "GeographicSiteRelationship": { "type": "object", "required": [ "id", "relationshipType" ], "properties": { "id": { "description": "Unique identifier of the related site entity within the server", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Reference of the related geographic site", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relationshipType": { "description": "Type of relationship", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "description": "Role of the related site in the relationship", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "validFor": { "description": "Validity for the relationship", "type": "object", "properties": { "endDateTime": { "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "startDateTime": { "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end", "example": "1985-04-12T23:20:50.52Z", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "PlaceRefOrValue": { "description": "A place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the PlaceRefOrValue class itself", "type": "object", "properties": { "id": { "description": "Unique identifier of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Unique reference of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "CalendarPeriod": { "type": "object", "required": [ "hourPeriod" ], "properties": { "day": { "description": "Day where the calendar status applies (e.g.: monday, mon-to-fri, weekdays, weekend, all week, ...)", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "description": "Indication of the availability of the site (e.g.: open)", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "timeZone": { "description": "Indication of the timezone applicable to the calendar information (e.g.: Paris, GMT+1)", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "hourPeriod": { "type": "array", "items": { "$ref": "#/components/schemas/HourPeriod" } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "CharacteristicRelationship": { "description": "Another Characteristic that is related to the current Characteristic;", "type": "object", "properties": { "id": { "description": "Unique identifier of the characteristic", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relationshipType": { "description": "The type of relationship", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ConstraintRef": { "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.", "type": "object", "required": [ "id", "href" ], "properties": { "id": { "description": "reference id to the target constraint", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "Hyperlink reference to the target constraint", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "Name given to the constraint", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "version": { "description": "constraint version", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The (class) type of the referred constraint", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "FeatureRelationship": { "description": "Configuration feature", "type": "object", "required": [ "name", "relationshipType" ], "properties": { "id": { "description": "Unique identifier of the target feature.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "This is the name of the target feature.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relationshipType": { "description": "This is the type of the feature relationship.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "validFor": { "description": "The period for which this feature relationship is valid.", "type": "object", "properties": { "endDateTime": { "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "startDateTime": { "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end", "example": "1985-04-12T23:20:50.52Z", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ResourceRefOrValue": { "description": "A resource to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself", "type": "object", "required": [ "id", "href" ], "properties": { "id": { "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "description": "The URI for the object itself.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "category": { "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "description": { "description": "free-text description of the resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "endOperatingDate": { "description": "A date time( DateTime). The date till the resource is operating", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "description": "A string used to give a name to the resource", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "resourceVersion": { "description": "A field that identifies the specific version of an instance of a resource.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "startOperatingDate": { "description": "A date time( DateTime). The date from which the resource is operating", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "activationFeature": { "description": "Configuration features", "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "administrativeState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "locked", "unlocked", "shutdown" ], "type": "string" }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "operationalState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "enable", "disable" ], "type": "string" }, "place": { "$ref": "#/components/schemas/RelatedPlaceRefOrValue" }, "relatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "resourceCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } }, "resourceRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRelationship" } }, "resourceSpecification": { "$ref": "#/components/schemas/ResourceSpecificationRef" }, "resourceStatus": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ], "type": "string" }, "usageState": { "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on.", "enum": [ "idle", "active", "busy" ], "type": "string" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "HourPeriod": { "type": "object", "properties": { "endHour": { "description": "The time when the status ends applying", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "startHour": { "description": "The time when the status starts applying", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@basetype": { "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "description": "When sub-classing, this defines the sub-class entity name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }