{"swagger":"2.0","info":{"title":"A1 Events","description":"This is Swagger UI environment generated for the Tmf Events implemented in TUA","version":"1.0"},"host":"serverRoot","paths":{},"definitions":{"Event":{"type":"object","description":"event with common attributes.","discriminator":"@type","properties":{"correlationId":{"type":"string","description":"The correlation id for this event.","pattern":"^[^<>\"'&]*$"},"description":{"type":"string","description":"An explanatory of the event.","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the related entity."},"domain":{"type":"string","description":"The domain of the event.","pattern":"^[^<>\"'&]*$"},"eventId":{"type":"string","description":"The identifier of the notification.","pattern":"^[^<>\"'&]*$"},"eventTime":{"type":"string","format":"date-time","description":"Time of the event occurrence."},"eventType":{"type":"string","description":"The type of the notification.","pattern":"^[^<>\"'&]*$"},"priority":{"type":"string","description":"A priority.","pattern":"^[^<>\"'&]*$"},"timeOccurred":{"type":"string","format":"date-time","description":"The time the event occurred."},"title":{"type":"string","description":"The title of the event.","pattern":"^[^<>\"'&]*$"},"relatedParty":{"type":"array","items":{"$ref":"#/definitions/RelatedParty"}},"reportingSystem":{"$ref":"#/definitions/EntityRef","description":"Reporting System described by EntityRef"},"source":{"$ref":"#/definitions/EntityRef","description":"Source Entity described by EntityRef"},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"}}},"EntityRef":{"type":"object","description":"Entity reference schema to be use for all entityRef class.","properties":{"id":{"type":"string","description":"Unique identifier of a related entity.","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the related entity."},"name":{"type":"string","description":"Name of the related entity.","pattern":"^[^<>\"'&]*$"},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"},"@referredType":{"type":"string","description":"The actual type of the target instance when needed for disambiguation.","pattern":"^[^<>\"'&]*$"}}},"ProductOrderEventPayload":{"type":"object","description":"Represents payload for product order events","discriminator":"@type","properties":{"ProductOrder":{"$ref":"#/definitions/ProductOrder"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"}}},"ProductOrderCreateEvent":{"description":"Event which should be sent after order cration","allOf":[{"$ref":"#/definitions/Event"},{"type":"object","properties":{"event":{"$ref":"#/definitions/ProductOrderEventPayload","description":"The event linked to the involved resource object"}}}]},"RelatedParty":{"description":"The party which the product is related with.","type":"object","properties":{"id":{"description":"Unique identifier of the related party","type":"string","pattern":"^[^<>\"'&]*$"},"href":{"description":"Reference of the related party","type":"string"},"name":{"description":"Name of the related party","type":"string","pattern":"^[^<>\"'&]*$"},"role":{"description":"Role played by the related party","type":"string","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"}}},"ProductOrder":{"type":"object","properties":{"document":{"type":"array","items":{"$ref":"#/definitions/DocumentRef"}},"characteristic":{"type":"array","items":{"$ref":"#/definitions/OrderCharacteristic"}},"place":{"type":"array","items":{"$ref":"#/definitions/Place"}},"id":{"type":"string","description":"ID created on repository side (OM system)","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Hyperlink to access the order"},"externalId":{"type":"string","description":"ID given by the consumer and only understandable by him (to facilitate his searches afterwards).","pattern":"^[^<>\"'&]*$"},"shoppingCart":{"description":"Reference to the shopping cart resource collecting purchase entries used as input for place order","$ref":"#/definitions/ShoppingCartRef"},"baseSiteId":{"type":"string","description":"Identifier of the base site","pattern":"^[^<>\"'&]*$"},"priority":{"$ref":"#/definitions/PriorityType"},"description":{"type":"string","description":"Description of the product order","pattern":"^[^<>\"'&]*$"},"category":{"type":"string","description":"Used to categorize the order from a business perspective that can be useful for the OM system (e.g. 'enterprise', 'residential', ...).","pattern":"^[^<>\"'&]*$"},"state":{"$ref":"#/definitions/StateType"},"orderDate":{"type":"string","format":"date-time","description":"Date when the order was created"},"completionDate":{"type":"string","format":"date-time","description":"Date when the order was completed."},"requestedStartDate":{"type":"string","format":"date-time","description":"Order start date wished by the requestor"},"requestedCompletionDate":{"type":"string","format":"date-time","description":"Requested delivery date from the requestor perspective"},"expectedCompletionDate":{"type":"string","format":"date-time","description":"Expected delivery date amended by the provider"},"notificationContact":{"type":"string","description":"Contact attached to the order to send back information regarding this order","pattern":"^[^<>\"'&]*$"},"@baseType":{"type":"string","description":"Indicates the base type of the resource. Here can be 'ProductOrder'.","pattern":"^[^<>\"'&]*$"},"@type":{"type":"string","description":"Indicates the type of resource. Here can be 'ProductOrder'."},"@schemaLocation":{"type":"string","description":"A link to the schema describing this REST resource."},"channel":{"type":"array","items":{"$ref":"#/definitions/Channel"}},"note":{"type":"array","items":{"$ref":"#/definitions/Note"}},"relatedParty":{"type":"array","items":{"$ref":"#/definitions/RelatedPartyRef"}},"payment":{"type":"array","items":{"$ref":"#/definitions/PaymentRef"}},"billingAccount":{"$ref":"#/definitions/BillingAccountRef"},"orderTotalPrice":{"type":"array","items":{"$ref":"#/definitions/OrderPrice"}},"orderItem":{"type":"array","items":{"$ref":"#/definitions/OrderItem"}},"promotion":{"type":"array","items":{"$ref":"#/definitions/PromotionRef"}},"orderCost":{"type":"array","description":"Represents the delivery and payment costs for the order","items":{"$ref":"#/definitions/OrderPrice"}},"deliveryMode":{"description":"Reference to the delivery mode","$ref":"#/definitions/DeliveryModeRef"}}},"PriorityType":{"description":"Priority","type":"string","enum":["0","1","2","3","4"]},"DocumentRef":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the document","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"The URI for the object itself."},"@referredType":{"type":"string","description":"The Referred Type of the document.","pattern":"^[^<>\"'&]*$"}}},"BillingAccountRef":{"description":"A BillingAccount is a detailed description of a bill structure","required":["id"],"type":"object","properties":{"id":{"description":"Unique identier of the billing account","type":"string","pattern":"^[^<>\"'&]*$"},"href":{"description":"Reference of the billing account","type":"string"},"name":{"description":"Name of the billing account","type":"string","pattern":"^[^<>\"'&]*$"},"@referredType":{"description":"Indicates the (class) type of the billing account","type":"string","pattern":"^[^<>\"'&]*$"}}},"Channel":{"description":"The channel defines the channel for selling product offerings where order has been submitted.","required":["id"],"type":"object","properties":{"id":{"description":"Unique identifier of  the channel","type":"string","pattern":"^[^<>\"'&]*$"},"href":{"description":"Unique reference of the channel","type":"string"},"name":{"description":"Name of the channel","type":"string","pattern":"^[^<>\"'&]*$"},"role":{"description":"Role of the channel - could be 'initChannel', 'submitChannel' for example.","type":"string","pattern":"^[^<>\"'&]*$"},"@type":{"description":"Indicates the (class) type of resource.","type":"string"}}},"OrderPrice":{"discriminator":"@type","description":"An amount, usually of money, that represents the actual price paid by the Customer for this item or this order.","type":"object","properties":{"name":{"description":"A short descriptive name such as \"Subscription price\".","type":"string","pattern":"^[^<>\"'&]*$"},"id":{"type":"string","description":"id","pattern":"^[^<>\"'&]*$"},"description":{"description":"A narrative that explains in detail the semantics of this order item price","type":"string","pattern":"^[^<>\"'&]*$"},"priceType":{"$ref":"#/definitions/PriceType"},"unitOfMeasure":{"description":"Could be minutes, gigaBytes,...","type":"string","pattern":"^[^<>\"'&]*$"},"recurringChargePeriod":{"description":"Could be month, week,...","type":"string","pattern":"^[^<>\"'&]*$"},"usageChargeType":{"type":"string","description":"The type of the usage charge.","pattern":"^[^<>\"'&]*$"},"@type":{"description":"Indicate the type of orderPrice.","type":"string"},"@baseType":{"description":"Indicate the base type of orderPrice.","type":"string","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"description":"A link to the schema describing this orderPrice extension.","type":"string"},"price":{"$ref":"#/definitions/Price"},"priceAlteration":{"type":"array","items":{"$ref":"#/definitions/PriceAlteration"}},"billingAccount":{"$ref":"#/definitions/BillingAccountRef"},"orderPrice":{"type":"array","items":{"$ref":"#/definitions/OrderPrice"}},"productOfferingPrice":{"$ref":"#/definitions/ProductOfferingPriceRef","description":"An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time."}}},"OrderCharacteristic":{"description":"A characteristic to specify the product order. Can be used in downstream systems","type":"object","properties":{"name":{"description":"Name of the characteristic","type":"string","pattern":"^[^<>\"'&]*$"},"value":{"description":"Value of the characteristic","type":"string","pattern":"^[^<>\"'&]*$"},"@type":{"description":"Indicates the (class) type of resource","type":"string"},"@schemaLocation":{"description":"This field provided a link to the schema describing this REST resource.","type":"string"}}},"RelatedPartyRef":{"type":"object","description":"RelatedParty reference. A related party defines party or party role linked to a specific entity.","properties":{"individualIdentification":{"$ref":"#/definitions/IndividualIdentification"},"id":{"type":"string","description":"Unique identifier of a related party","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the related party, could be a party reference or a party role reference"},"role":{"type":"string","description":"Role of the related party.","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"Name of the related party","pattern":"^[^<>\"'&]*$"},"validFor":{"description":"Validity period of the related party","$ref":"#/definitions/TimePeriod"},"@referredType":{"type":"string","description":"The class type of referred party/party role reference","pattern":"^[^<>\"'&]*$"}}},"DeliveryModeRef":{"type":"object","description":"","properties":{"id":{"type":"string","description":"Unique identifier of the delivery mode.","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"Name of the delivery mode.","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the delivery mode."},"@type":{"type":"string","description":"Class type of the delivery mode"},"@referredType":{"type":"string","description":"(Class) type of the referred delivery mode","pattern":"^[^<>\"'&]*$"}}},"StateType":{"description":"","type":"string","enum":["CANCELLING","CHECKED_VALID","CREATED","OPEN","CHECKED_INVALID","ON_VALIDATION","PENDING_APPROVAL","SUSPENDED","COMPLETED","PAYMENT_AUTHORIZED","PENDING_APPROVAL_FROM_MERCHANT","CANCELLED","PAYMENT_NOT_AUTHORIZED","PENDING_QUOTE","APPROVED_QUOTE","PAYMENT_AMOUNT_RESERVED","PAYMENT_AMOUNT_NOT_RESERVED","REJECTED_QUOTE","APPROVED","PAYMENT_CAPTURED","PAYMENT_NOT_CAPTURED","REJECTED","APPROVED_BY_MERCHANT","FRAUD_CHECKED","ORDER_SPLIT","REJECTED_BY_MERCHANT","ASSIGNED_TO_ADMIN","PROCESSING_ERROR","B2B_PROCESSING_ERROR","WAIT_FRAUD_MANUAL_CHECK","PAYMENT_NOT_VOIDED","TAX_NOT_VOIDED","TAX_NOT_COMMITTED","TAX_NOT_REQUOTED"]},"Note":{"type":"object","description":"Extra information about a given entity","required":["id","text"],"properties":{"id":{"type":"string","description":"Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)","pattern":"^[^<>\"'&]*$"},"author":{"type":"string","description":"Author of the note","pattern":"^[^<>\"'&]*$"},"date":{"type":"string","format":"date-time","description":"Date of the note"},"text":{"type":"string","description":"Text of the note","pattern":"^[^<>\"'&]*$"},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"}}},"OrderItem":{"description":"An identified part of the order. A product order is decomposed into one or more order items.","required":["id","action"],"type":"object","properties":{"id":{"description":"Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)","type":"string","pattern":"^[^<>\"'&]*$"},"action":{"$ref":"#/definitions/ActionType","description":"The action to be carried out on the Product. Can be \"add\" / \"update\" / \"keep\" / \"remove\""},"state":{"$ref":"#/definitions/StateType"},"quantity":{"description":"Quantity ordered","type":"integer","format":"int64"},"@type":{"description":"Indicates the type of resource. Here it can be a type of productOrderItem.","type":"string"},"@schemaLocation":{"description":"An URL to the schema describing this REST resource.","type":"string"},"appointment":{"$ref":"#/definitions/AppointmentRef"},"billingAccount":{"$ref":"#/definitions/BillingAccountRef"},"itemPrice":{"type":"array","items":{"$ref":"#/definitions/OrderPrice"}},"itemTotalPrice":{"type":"array","items":{"$ref":"#/definitions/OrderPrice"}},"productOffering":{"$ref":"#/definitions/ProductOfferingRef"},"product":{"$ref":"#/definitions/Product"},"orderItemRelationship":{"type":"array","items":{"$ref":"#/definitions/OrderItemRelationShip"}},"qualification":{"type":"array","items":{"$ref":"#/definitions/QualificationRef"}},"payment":{"type":"array","items":{"$ref":"#/definitions/PaymentRef"}},"itemTerm":{"type":"array","items":{"$ref":"#/definitions/OrderTerm"}},"orderItem":{"type":"array","items":{"$ref":"#/definitions/OrderItem"}},"processType":{"$ref":"#/definitions/ProcessType","description":"Process type"},"promotion":{"type":"array","items":{"$ref":"#/definitions/PromotionRef"}},"contractStartDate":{"description":"Date when the contract was created","type":"string","format":"date-time"}}},"PromotionRef":{"type":"object","description":"Reference to promotion.","properties":{"@type":{"type":"string","description":"Generic attribute containing the name of the resource class type"},"@referredType":{"type":"string","description":"Class type of the referred promotion.","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Url used to reference the promotion."},"id":{"type":"string","description":"Unique identifier for promotion.","pattern":"^[^<>\"'&]*$"},"status":{"$ref":"#/definitions/Status","description":"The status of the promotion."},"message":{"type":"string","description":"Promotion description","pattern":"^[^<>\"'&]*$"}}},"PaymentRef":{"description":"Payment information captured and stored (as a reference) in the order.","type":"object","properties":{"@type":{"description":"Indicates the type of resource.","type":"string"},"id":{"type":"string","description":"Identifier of a payment.","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Hyperlink to access to a payment."},"name":{"type":"string","description":"Name of a payment.","pattern":"^[^<>\"'&]*$"},"code":{"type":"string","description":"Unique identifier of the voucher","pattern":"^[^<>\"'&]*$"},"type":{"type":"string","description":"Payment method type. The content of the details field depends on the value of this one","enum":["VOUCHER","CREDITCARD"]},"@referredType":{"type":"string","description":"Indicates the type of resource. Here can be 'cash', 'BankCard', ‘Check’, etc...","pattern":"^[^<>\"'&]*$"}}},"ShoppingCartRef":{"type":"object","description":"Reference to the shopping cart","required":["id"],"properties":{"id":{"description":"Unique identifier of the shopping cart","type":"string","pattern":"^[^<>\"'&]*$"},"href":{"description":"Reference of the shopping cart","type":"string"}}},"Place":{"description":"Place defines the places where the products are sold, delivered. A place may be used for marking a geo location.","required":["role"],"type":"object","properties":{"id":{"description":"Unique identifier of the place","type":"string","pattern":"^[^<>\"'&]*$"},"href":{"description":"Reference of the place","type":"string"},"name":{"description":"A user-friendly name for the place","type":"string","pattern":"^[^<>\"'&]*$"},"role":{"description":"Role of the place (for instance: 'installation site', 'A-extremity site', 'Supervised Perimeter' etc...)","type":"string","pattern":"^[^<>\"'&]*$"},"@referredType":{"description":"Indicate the type of Place class (example: 'geographicAddress')","type":"string","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"description":"A link to the schema describing this REST resource","type":"string"}}},"PriceAlteration":{"type":"object","description":"An amount, usually of money, that alters a product offering price.","properties":{"promotion":{"$ref":"#/definitions/Promotion","description":"Applied promotion"},"id":{"type":"string","description":"Identifier of PriceAlteration in inventory","pattern":"^[^<>\"'&]*$"},"productOfferingPrice":{"$ref":"#/definitions/ProductOfferingPriceRef"},"validFor":{"$ref":"#/definitions/TimePeriod","description":"The period for which the priceAlteration is valid (duration start - end dateTime)."},"alteredPrice":{"$ref":"#/definitions/Price"},"@baseType":{"type":"string","description":"Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current  object is unknown to the implementation.","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","description":"Generic attribute containing the link to the schema that defines the structure of the class type of the current object."},"@type":{"type":"string","description":"Generic attribute containing the name of the resource class type"},"applicationDuration":{"type":"integer","description":"Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge)"},"description":{"type":"string","description":"A narrative that explains in detail the semantics of this order item price alteration","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"A short descriptive name such as \"Monthly discount\"","pattern":"^[^<>\"'&]*$"},"priceType":{"type":"string","description":"A category that describes the price such as recurring, one time and usage.","pattern":"^[^<>\"'&]*$"},"priority":{"type":"integer","description":"Priority level for applying this alteration among all the defined alterations on the order item price"},"recurringChargePeriod":{"type":"string","description":"Could be month, week...","pattern":"^[^<>\"'&]*$"},"unitOfMeasure":{"type":"string","description":"Could be minutes, GB...","pattern":"^[^<>\"'&]*$"},"price":{"$ref":"#/definitions/Price"},"cycle":{"$ref":"#/definitions/Cycle"}}},"ProductOfferingPriceRef":{"type":"object","description":"ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased","properties":{"id":{"type":"string","description":"Unique identifier of a related entity.","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the related entity."},"name":{"type":"string","description":"Name of the related entity.","pattern":"^[^<>\"'&]*$"},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"},"@referredType":{"type":"string","description":"The actual type of the target instance when needed for disambiguation.","pattern":"^[^<>\"'&]*$"}},"required":["id"]},"Price":{"properties":{"nonIndexedDutyFreeAmount":{"$ref":"#/definitions/Money","description":"non indexed base pice"},"idxStatus":{"type":"string","description":"Status of indexation in inventory. Either IndexedNotStarted, Indexed, or NotIndexed","pattern":"^[^<>\"'&]*$"},"idxDate":{"type":"string","format":"date-time","description":"Indexing date"},"taxIncludedAmount":{"$ref":"#/definitions/Money"},"dutyFreeAmount":{"$ref":"#/definitions/Money"},"percentage":{"type":"number","format":"float","description":"Percentage applied"},"taxRate":{"type":"number","format":"float","description":"Applied tax rate on amount"},"@type":{"type":"string","description":"Indicates the (class) type of the price"},"@schemaLocation":{"type":"string","description":"Link to the schema describing this REST resource."}}},"PriceType":{"description":"","type":"string","enum":["recurring","oneTime","usage","PRODUCT_PRICE","DELIVERY_COST","PAYMENT_COST","DISCOUNT"]},"TimePeriod":{"description":"A time period described through 2 dates","type":"object","properties":{"startDateTime":{"type":"string","format":"date-time"},"endDateTime":{"type":"string","format":"date-time"}}},"IndividualIdentification":{"type":"object","description":"Represents our registration of information used as proof of identity by an individual (passport, national identity card, driver’s license, social security number, birth certificate).","required":["identificationId","identificationType"],"properties":{"identificationId":{"description":"A string. Identifier.","type":"string","pattern":"^[^<>\"'&]*$"},"identificationType":{"description":"A string. Identification type (passport, national identity card, driver’s license, social security number, birth certificate).","type":"string","pattern":"^[^<>\"'&]*$"},"issuingAuthority":{"description":"A string. Authority which has issued the identifier, such as: social security, town hall.","type":"string","pattern":"^[^<>\"'&]*$"},"issuingDate":{"description":"A date time (DateTime). Date at which the identifier was issued.","type":"string","format":"date-time"},"validFor":{"$ref":"#/definitions/TimePeriod","description":"A time period. The period for which the identification information is valid."},"attachment":{"type":"array","description":"An attachment ref or value (AttachmentRefOrValue). An attachment by value or by reference.","items":{"$ref":"#/definitions/Attachment"}}}},"OrderTerm":{"properties":{"id":{"description":"Identifier of an Order Term.","type":"string","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"Name of the productOrderTerm.","pattern":"^[^<>\"'&]*$"},"description":{"type":"string","description":"Description of the productOrderTerm.","pattern":"^[^<>\"'&]*$"},"duration":{"$ref":"#/definitions/Quantity"},"@type":{"type":"string","description":"Indicated the type of Term."}}},"ActionType":{"description":"","type":"string","enum":["ADD","UPDATE","KEEP","REMOVE"]},"ProductOfferingRef":{"discriminator":"@type","type":"object","description":"ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.","properties":{"category":{"type":"array","items":{"$ref":"#/definitions/CategoryRef"}},"id":{"type":"string","description":"Unique identifier of the product offering","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the product offering"},"name":{"type":"string","description":"Name of the product offering","pattern":"^[^<>\"'&]*$"},"image":{"description":"Thumbnail image of the product offering","$ref":"#/definitions/Attachment"},"variantOption":{"type":"array","description":"Variant options, in case of a variant product offering.","items":{"$ref":"#/definitions/VariantOption"}},"@referredType":{"type":"string","description":"Type (class) of the product offering","pattern":"^[^<>\"'&]*$"},"@type":{"type":"string","description":"Type (class) of the product offering"}}},"Product":{"properties":{"description":{"type":"string","pattern":"^[^<\"']*$"},"terminationReason":{"type":"string","description":"Termination Reason","pattern":"^[^<>\"'&]*$"},"promotion":{"type":"array","items":{"$ref":"#/definitions/Promotion"}},"realizingService":{"type":"array","items":{"$ref":"#/definitions/ServiceRefOrValue"}},"id":{"type":"string","description":"Unique identifier of the product","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the product"},"isBundle":{"type":"boolean","description":"If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering"},"isCustomerVisible":{"type":"boolean","description":"If true, the product is visible by the customer"},"name":{"type":"string","description":"The name of the product. It could be the same as the name of the Product Offering","pattern":"^[^<>\"'&]*$"},"productSerialNumber":{"type":"string","description":"Serial number for the product. This is typically applicable to tangible products e.g. Broadband Router.","pattern":"^[^<>\"'&]*$"},"startDate":{"type":"string","format":"date-time","description":"The date from which the product starts"},"status":{"$ref":"#/definitions/StatusType"},"terminationDate":{"type":"string","format":"date-time","description":"The date when the product was terminated. Not applicable to active products"},"@baseType":{"type":"string","description":"Indicates the base type of the resource. Here can be 'Product'","pattern":"^[^<>\"'&]*$"},"@type":{"type":"string","description":"Indicated the type of resource."},"@schemaLocation":{"type":"string","description":"A link to the schema describing this REST resource."},"place":{"type":"array","items":{"$ref":"#/definitions/Place"}},"productOffering":{"$ref":"#/definitions/ProductOfferingRef"},"productSpecification":{"$ref":"#/definitions/ProductSpecification"},"characteristic":{"type":"array","items":{"$ref":"#/definitions/ProductCharacteristic"}},"productRelationship":{"type":"array","items":{"$ref":"#/definitions/ProductRelationship"}},"billingAccount":{"type":"array","items":{"$ref":"#/definitions/BillingAccountRef"}},"relatedParty":{"type":"array","items":{"$ref":"#/definitions/RelatedParty"}},"realizingResource":{"type":"array","items":{"$ref":"#/definitions/RealizingResource"}},"productPrice":{"type":"array","items":{"$ref":"#/definitions/ProductPrice"}},"productOrder":{"type":"array","items":{"$ref":"#/definitions/ProductOrderRef"}},"productTerm":{"type":"array","items":{"$ref":"#/definitions/ProductTerm"}}}},"AppointmentRef":{"discriminator":"@type","type":"object","description":"Contains information of a booked appointment","properties":{"externalKey":{"type":"string","description":"The reference key to the appointment in the external system","pattern":"^[^<>\"'&]*$"},"dateTimeStart":{"type":"string","format":"date-time","description":"The start datetime of the appointment"},"dateTimeEnd":{"type":"string","format":"date-time","description":"The end datetime of the appointment"},"permitted":{"type":"boolean","description":"Whether the appointment is permitted or not"},"sourceSystem":{"type":"string","description":"The source system of the appointment","pattern":"^[^<>\"'&]*$"},"firstName":{"type":"string","description":"The contact first name of the appointment","pattern":"^[^<>\"'&]*$"},"lastName":{"type":"string","description":"The contact last name of the appointment","pattern":"^[^<>\"'&]*$"},"contactNumber":{"type":"string","description":"The contact number of the appointment","pattern":"^[^<>\"'&]*$"},"byPhone":{"type":"boolean","description":"Whether the appointment is by phone or not"},"type":{"type":"string","description":"The type of the appointment","enum":["SELBSTINSTALLATION","TECHNIKERINSTALLATION"]},"@type":{"description":"Type","type":"string"},"href":{"type":"string","description":"Hyperlink to access the appointment"},"id":{"type":"string","description":"id of the appointment","pattern":"^[^<>\"'&]*$"},"@referredType":{"type":"string","description":"Indicates the (class) type of resource.","pattern":"^[^<>\"'&]*$"}}},"OrderItemRelationShip":{"description":"Linked order items to the one instantiate.","required":["type","id"],"type":"object","properties":{"type":{"$ref":"#/definitions/RelationShipType"},"id":{"description":"The identifier of the related ordered item.","type":"string","pattern":"^[^<>\"'&]*$"}}},"ProcessType":{"type":"object","description":"Process type. It could be ACQUISITION, RETENTION, CHANGE TARIFF","properties":{"id":{"type":"string","description":"Process Type id.","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the Process Type."},"@type":{"description":"Indicated the type of the ProcessType","type":"string"},"@schemaLocation":{"description":"A link to the schema describing the ProcessType","type":"string"}}},"QualificationRef":{"description":"It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide 'eligibility' information.","required":["id","href"],"type":"object","properties":{"id":{"description":"Identifier of a pre-existing qualification.","type":"string","pattern":"^[^<>\"'&]*$"},"href":{"description":"href of the qualification.","type":"string"},"qualificationItemId":{"description":"Id of an item of a qualification.","type":"string","pattern":"^[^<>\"'&]*$"},"@referredType":{"description":"Indicates the type of resource. Here it can be a type of qualification. (could a service qualification or a product offering qualification).","type":"string","pattern":"^[^<>\"'&]*$"}}},"Status":{"description":"Status of the promotion.","type":"string","enum":["APPLIED","POTENTIAL"]},"Promotion":{"type":"object","description":"Promotion metadata","properties":{"marketingTitle":{"type":"string","description":"Marketing title of Promotion","pattern":"^[^<>\"'&]*$"},"marketingDescription":{"type":"string","description":"Marketing description of Promotion","pattern":".*$"},"marketingSummary":{"type":"string","description":"Marketing summary of Promotion","pattern":"^[^<>\"'&]*$"},"id":{"type":"string","description":"Unique identifier of Promotion.","pattern":"^[^<>\"'&]*$"},"promotionId":{"type":"string","description":"ID of the promotion in inventory","pattern":"^[^<>\"'&]*$"},"promotionCode":{"type":"string","description":"Code of the promotion","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"Name of Promotion.","pattern":"^[^<>\"'&]*$"}}},"Cycle":{"type":"object","description":"Represents the billing cycle.","properties":{"cycleStart":{"type":"integer","description":"Starting cycle."},"cycleEnd":{"type":"integer","description":"Ending cycle."}}},"Money":{"description":"A base / value business entity used to represent money.","type":"object","properties":{"currencySymbol":{"description":"Symbol of the currency","type":"string","pattern":"^[^<>\"'&]*$"},"fractionalPart":{"description":"A positive number representing the fractional part of a floating point number (2 digits).","type":"string","pattern":"^[^<>\"'&]*$"},"integerPart":{"description":"A positive number representing the integer part of a floating point number.","type":"string","pattern":"^[^<>\"'&]*$"},"value":{"type":"string","description":"A positive floating point number","pattern":"^[^<>\"'&]*$"},"unit":{"type":"string","description":"Currency (ISO4217 norm uses 3 letters to define the currency).","pattern":"^[^<>\"'&]*$"}}},"Attachment":{"type":"object","description":"Media items configured for a product offering (images, videos).","properties":{"description":{"type":"string","description":"A narrative text describing the content of the attachment","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Not Sent.Reference of the attachment."},"id":{"type":"string","description":"Unique identifier of the attachment","pattern":"^[^<>\"'&]*$"},"type":{"type":"string","description":"Attachment type format.","pattern":"^[^<>\"'&]*$"},"url":{"type":"string","description":"Uniform Resource Locator, is a web page address (a subset of URI)","pattern":"^[^<>\"'&]*$"},"mimeType":{"type":"string","description":"Attachment mime type such as extension file for video, picture and document","pattern":"^[^<>\"'&]*$"},"validFor":{"description":"Not Sent.","$ref":"#/definitions/TimePeriod"},"@type":{"type":"string","description":"the class type of the Attachment"},"@baseType":{"type":"string","description":"The immediate base class type of the attachment","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","description":"A link to the schema describing this attachment entity"}}},"Quantity":{"description":"Description of a quantity like for the Duration attribute","required":["amount","units"],"type":"object","properties":{"amount":{"description":"A value for the quantity","type":"number","format":"float"},"units":{"description":"A unit associated with the quantity (for example months)","type":"string","pattern":"^[^<>\"'&]*$"}}},"VariantOption":{"type":"object","description":"Variant characteristics.","properties":{"id":{"type":"string","description":"Unique reference of the variant option","pattern":"^[^<>\"'&]*$"},"variantCategory":{"type":"string","description":"Variant Category.","pattern":"^[^<>\"'&]*$"},"variantValue":{"type":"string","description":"Variant Value.","pattern":"^[^<>\"'&]*$"}},"required":["variantCategory","variantValue"]},"CategoryRef":{"type":"object","description":"Category reference. The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings.","properties":{"id":{"type":"string","description":"Unique reference of the category","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Not Sent.Unique reference of the category."},"version":{"type":"string","description":"Not Sent.Category version.","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"Name of the category","pattern":"^[^<>\"'&]*$"},"type":{"type":"string","description":"Category type, can be Category,VariantCategory or VariantValueCategory.","pattern":"^[^<>\"'&]*$"},"@referredType":{"type":"string","description":"The class type of the referred Category","pattern":"^[^<>\"'&]*$"}}},"ProductCharacteristic":{"description":"Characteristics of the product to instantiate or to modify.","type":"object","properties":{"productSpecCharacteristic":{"$ref":"#/definitions/ProductSpecCharacteristicRef","description":"An object containing the id of the PSC"},"productSpecCharacteristicValue":{"$ref":"#/definitions/ProductSpecCharacteristicValueRef","description":"An object containing the id of the PSCV"},"value":{"description":"Value of the characteristic","type":"string","pattern":".*$"},"name":{"type":"string","description":"Name of the characteristic","pattern":"^[^<>\"'&]*$"},"@type":{"type":"string","description":"Indicates the (class) type of resource"},"@schemaLocation":{"type":"string","description":"This field provided a link to the schema describing this REST resource."}}},"ServiceRefOrValue":{"type":"object","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","properties":{"id":{"type":"string","description":"Unique identifier of the service","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the service"},"category":{"type":"string","description":"Is it a customer facing or resource facing service","pattern":"^[^<>\"'&]*$"},"description":{"type":"string","description":"Free-text description of the service","pattern":"^[^<>\"'&]*$"},"endDate":{"type":"string","format":"date-time","description":"Date when the service ends"},"hasStarted":{"type":"boolean","description":"If TRUE, this Service has already been started"},"isBundle":{"type":"boolean","description":"If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)."},"isServiceEnabled":{"type":"boolean","description":"If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed "},"isStateful":{"type":"boolean","description":"If TRUE, this Service can be changed without affecting any other services"},"name":{"type":"string","description":"Name of the service","pattern":"^[^<>\"'&]*$"},"serviceDate":{"type":"string","description":"Date when the service was created (whatever its status).","pattern":"^[^<>\"'&]*$"},"serviceType":{"type":"string","description":"Business type of the service","pattern":"^[^<>\"'&]*$"},"startDate":{"type":"string","format":"date-time","description":"Date when the service starts"},"startMode":{"type":"string","description":"This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above","pattern":"^[^<>\"'&]*$"},"feature":{"type":"array","items":{"$ref":"#/definitions/Feature"},"description":"A list of feature associated with this service "},"note":{"type":"array","items":{"$ref":"#/definitions/Note"},"description":"A list of notes made on this service"},"place":{"type":"array","items":{"$ref":"#/definitions/RelatedPlaceRefOrValue"},"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)"},"relatedEntity":{"type":"array","items":{"$ref":"#/definitions/RelatedEntityRefOrValue"},"description":"A list of related  entity in relationship with this service "},"relatedParty":{"type":"array","items":{"$ref":"#/definitions/RelatedParty"},"description":"A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity"},"serviceCharacteristic":{"type":"array","items":{"$ref":"#/definitions/Characteristic"},"description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) "},"serviceOrderItem":{"type":"array","items":{"$ref":"#/definitions/RelatedServiceOrderItem"},"description":"A list of service order items related to this service"},"serviceRelationship":{"type":"array","items":{"$ref":"#/definitions/ServiceRelationship"},"description":"A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory."},"serviceSpecification":{"$ref":"#/definitions/ServiceSpecificationRef","description":"The specification from which this service was instantiated"},"state":{"$ref":"#/definitions/ServiceStateType","description":"The life cycle state of the service, such as designed, reserved, active, etc..."},"supportingResource":{"type":"array","items":{"$ref":"#/definitions/ResourceRef"},"description":"A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources"},"supportingService":{"type":"array","items":{"$ref":"#/definitions/ServiceRefOrValue"},"description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)"},"@baseType":{"example":"ResourceSpecification","type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"example":"https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json","type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"example":"LogicalResourceSpecification","type":"string","description":"When sub-classing, this defines the sub-class Extensible name"},"@referredType":{"type":"string","description":"The actual type of the target instance when needed for disambiguation.","pattern":"^[^<>\"'&]*$"}}},"ProductPrice":{"properties":{"productOfferingPrice":{"$ref":"#/definitions/ProductOfferingPriceRef"},"prodPriceAlteration":{"type":"array","items":{"$ref":"#/definitions/PriceAlteration"}},"id":{"type":"string","description":"Unique identifier of a productOfferingPrice","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"A short descriptive name such as \"Subscription price\"","pattern":"^[^<>\"'&]*$"},"description":{"type":"string","description":"A narrative that explains in detail the semantics of this product price","pattern":"^[^<>\"'&]*$"},"priceType":{"type":"string","description":"A category that describes the price, such as recurring, discount, allowance, penalty, and so forth","pattern":"^[^<>\"'&]*$"},"recurringChargePeriod":{"type":"string","description":"Could be month, week...","pattern":"^[^<>\"'&]*$"},"unitOfMeasure":{"type":"string","description":"Could be minutes, GB...","pattern":"^[^<>\"'&]*$"},"@type":{"type":"string","description":"Indicates the type of ProductPrice class"},"@schemaLocation":{"type":"string","description":"A link to the schema describing this REST resource"},"price":{"$ref":"#/definitions/Price"},"billingAccount":{"$ref":"#/definitions/BillingAccountRef"}}},"ProductSpecification":{"description":"A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.","required":["id"],"type":"object","properties":{"id":{"description":"Unique identifier of the product specification","type":"string","pattern":"^[^<>\"'&]*$"},"href":{"description":"Reference of the product specification","type":"string"},"version":{"description":"Version of the product specification","type":"string","pattern":"^[^<>\"'&]*$"},"name":{"description":"Name of the product specification","type":"string","pattern":"^[^<>\"'&]*$"},"brand":{"type":"string","description":"The manufacturer or trademark of the specification","pattern":"^[^<>\"'&]*$"},"description":{"type":"string","description":"A narrative that explains in detail what the product specification is","pattern":"^[^<>\"'&]*$"},"isBundle":{"type":"boolean","description":"isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)."},"lastUpdate":{"type":"string","format":"date-time","description":"Date and time of the last update"},"lifecycleStatus":{"type":"string","description":"Used to indicate the current lifecycle status","pattern":"^[^<>\"'&]*$"},"productNumber":{"type":"string","description":"An identification number assigned to uniquely identity the specification","pattern":"^[^<>\"'&]*$"},"bundledProductSpecification":{"type":"array","items":{"$ref":"#/definitions/BundledProductSpecification"},"description":"A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification."},"productSpecCharacteristic":{"type":"array","items":{"$ref":"#/definitions/ProductSpecCharacteristic"},"description":"A characteristic quality or distinctive feature of a ProductSpecification.  The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process."},"serviceSpecification":{"type":"array","items":{"$ref":"#/definitions/ServiceSpecificationRef"},"description":"ServiceSpecification(s) required to realize a ProductSpecification."},"validFor":{"$ref":"#/definitions/TimePeriod","description":"The period for which the product specification is valid"},"usageSpecification":{"$ref":"#/definitions/UsageSpecificationRef","description":"The Product Usage Specification which describes the types of Usage events generated by offerings with this Product Specification"},"productSpecType":{"type":"array","items":{"$ref":"#/definitions/ProductSpecType"},"description":"Represents the product specification type"},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"}}},"ProductOrderRef":{"description":"The product order(s) related to this product inventory","required":["orderItemId"],"type":"object","properties":{"id":{"description":"Unique identifier of product order","type":"string","pattern":"^[^<>\"'&]*$"},"href":{"description":"Hypertext Reference of the product order","type":"string"},"@referredType":{"description":"Indicate the class (type) of productOrder","type":"string","pattern":"^[^<>\"'&]*$"},"orderItemId":{"description":"Identifier of the order item where the product was managed","type":"string","pattern":"^[^<>\"'&]*$"},"orderItemAction":{"description":"Action of the order item for this product","type":"string","pattern":"^[^<>\"'&]*$"}}},"ProductRelationship":{"description":"Type of the product relationship. it can be 'bundled' if the product is a bundle and you want to describe the 'bundled' products inside this bundle, 'reliesOn' if the product needs another already owned product to rely on \n(e.g. an option on an already owned mobile access product) or 'targets' or 'isTargeted' (depending on the way of expressing the link) for any other kind of links that may be useful","required":["product"],"type":"object","properties":{"type":{"description":"Type of the product relationship","type":"string","pattern":"^[^<>\"'&]*$"},"product":{"$ref":"#/definitions/ProductRef"}}},"StatusType":{"description":"","type":"string","enum":["created","pendingActive","cancelled","active","pendingTerminate","terminated","suspended","aborted"]},"RealizingResource":{"discriminator":"@type","description":"RealizingResource reference. RealizingResource is a link to the resource that realizes the product.","properties":{"value":{"type":"string","description":"The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)","pattern":"^[^<>\"'&]*$"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"},"id":{"type":"string","description":"Unique identifier of the resource","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the resource"},"name":{"type":"string","description":"Name of the resource.","pattern":"^[^<>\"'&]*$"},"role":{"type":"string","description":"Role of the resource","pattern":"^[^<>\"'&]*$"},"@referredType":{"type":"string","description":"Indicate the class (type) of the realizing resource","pattern":"^[^<>\"'&]*$"}}},"ProductTerm":{"discriminator":"@type","properties":{"id":{"description":"Unique identifier of the ProductTerm in inventory","type":"string","pattern":"^[^<>\"'&]*$"},"productOfferingTerm":{"description":"Reference to a ProductOfferingTerm","$ref":"#/definitions/ProductOfferingTermRef"},"productOfferingTermValue":{"description":"Reference to a ProductOfferingTermValue","$ref":"#/definitions/ProductOfferingTermValueRef"},"name":{"type":"string","description":"Name of the commitment term","pattern":"^[^<>\"'&]*$"},"description":{"type":"string","description":"Description of the commitment term","pattern":"^[^<>\"'&]*$"},"duration":{"$ref":"#/definitions/Quantity"},"validFor":{"$ref":"#/definitions/TimePeriod"},"@type":{"type":"string","description":"Indicate the class (type) of the product term"}}},"RelationShipType":{"description":"","type":"string","enum":["reliesOn","brings","hasParent","hasChild"]},"ProductSpecCharacteristicRef":{"type":"object","description":"Product Spec Characteristic reference.","properties":{"href":{"type":"string","description":"Reference of the product spec characteristic"},"id":{"type":"string","description":"Identifier of the product spec characteristic","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"Name of the product spec characteristic","pattern":"^[^<>\"'&]*$"},"@referredType":{"type":"string","description":"Class type of the referred product spec characteristic","pattern":"^[^<>\"'&]*$"}}},"ProductSpecCharacteristicValueRef":{"description":"Characteristics of the product to instantiate or to modify.","type":"object","properties":{"id":{"description":"Unique identifier of the referenced ProductSpecCharacteristicValue","type":"string","pattern":"^[^<>\"'&]*$"},"@type":{"description":"Indicates the (class) type of resource","type":"string"},"@schemaLocation":{"description":"This field provided a link to the schema describing this REST resource.","type":"string"}}},"ServiceSpecificationRef":{"type":"object","description":"Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.","properties":{"id":{"type":"string","description":"Unique identifier of the service specification","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the serviceSpecification"},"name":{"type":"string","description":"Name of the requiredServiceSpecification","pattern":"^[^<>\"'&]*$"},"version":{"type":"string","description":"Service specification version","pattern":"^[^<>\"'&]*$"},"@referredType":{"type":"string","description":"the class type of associated service specification","pattern":"^[^<>\"'&]*$"},"targetServiceSchema":{"$ref":"#/definitions/TargetServiceSchema","description":"A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification."},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"},"externalIdentifier":{"type":"array","items":{"$ref":"#/definitions/ExternalIdentifier"}}},"required":["id"]},"Characteristic":{"type":"object","description":"Describes a given characteristic of an object or entity through a name/value pair.","required":["name","value"],"properties":{"id":{"type":"string","description":"Unique identifier of the characteristic","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"Name of the characteristic","pattern":"^[^<>\"'&]*$"},"valueType":{"type":"string","description":"Data type of the value of the characteristic","pattern":"^[^<>\"'&]*$"},"characteristicRelationship":{"type":"array","items":{"$ref":"#/definitions/CharacteristicRelationship"}},"value":{"type":"string","description":"The value of the characteristic","pattern":"^[^<>\"'&]*$"},"@baseType":{"example":"ResourceSpecification","type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"example":"https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json","type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"example":"LogicalResourceSpecification","type":"string","description":"When sub-classing, this defines the sub-class Extensible name"}}},"RelatedPlaceRefOrValue":{"type":"object","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","required":["role"],"properties":{"id":{"type":"string","description":"Unique identifier of the place","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Unique reference of the place"},"name":{"type":"string","description":"A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]","pattern":"^[^<>\"'&]*$"},"postcode":{"type":"string","description":"Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode)","pattern":"^[^<>\"'&]*$"},"role":{"type":"string","pattern":"^[^<>\"'&]*$"},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"},"@referredType":{"type":"string","description":"The actual type of the target instance when needed for disambiguation.","pattern":"^[^<>\"'&]*$"}}},"RelatedServiceOrderItem":{"type":"object","description":"RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.","required":["itemId","serviceOrderId"],"properties":{"itemId":{"type":"string","description":"Identifier of the order item where the service was managed","pattern":"^[^<>\"'&]*$"},"role":{"type":"string","description":"role of the service order item for this service","pattern":"^[^<>\"'&]*$"},"serviceOrderHref":{"type":"string","description":"Reference of the related entity.","pattern":"^[^<>\"'&]*$"},"serviceOrderId":{"type":"string","description":"Unique identifier of a related entity.","pattern":"^[^<>\"'&]*$"},"itemAction":{"$ref":"#/definitions/OrderItemActionType","description":"Action of the order item for this service"},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"},"@referredType":{"type":"string","description":"The actual type of the target instance when needed for disambiguation.","pattern":"^[^<>\"'&]*$"}}},"ResourceRef":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of a related entity.","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the related entity."},"name":{"type":"string","description":"Name of the resource","pattern":"^[^<>\"'&]*$"},"value":{"type":"string","description":"The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)","pattern":"^[^<>\"'&]*$"},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"},"@referredType":{"type":"string","description":"The actual type of the target instance when needed for disambiguation.","pattern":"^[^<>\"'&]*$"}},"required":["id"]},"RelatedEntityRefOrValue":{"type":"object","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","required":["role"],"properties":{"id":{"type":"string","description":"Unique identifier of a related entity.","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the related entity."},"name":{"type":"string","description":"Name of the related entity.","pattern":"^[^<>\"'&]*$"},"role":{"type":"string","pattern":"^[^<>\"'&]*$"},"@baseType":{"example":"ResourceSpecification","type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"example":"https://mycsp.com:8080/tmf-api/schema/Resource/LogicalResourceSpecification.schema.json","type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"example":"LogicalResourceSpecification","type":"string","description":"When sub-classing, this defines the sub-class Extensible name"},"@referredType":{"type":"string","description":"The actual type of the target instance when needed for disambiguation.","pattern":"^[^<>\"'&]*$"}}},"ServiceRelationship":{"type":"object","required":["relationshipType"],"properties":{"relationshipType":{"type":"string","pattern":"^[^<>\"'&]*$"},"service":{"$ref":"#/definitions/ServiceRefOrValue"},"serviceRelationshipCharacteristic":{"type":"array","items":{"$ref":"#/definitions/Characteristic"}},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"}}},"ServiceStateType":{"type":"string","description":"Valid values for the lifecycle state of the service","enum":["feasibilityChecked","designed","reserved","inactive","active","terminated"]},"Feature":{"type":"object","description":"Configuration feature.","required":["featureCharacteristic","name"],"properties":{"id":{"type":"string","description":"Unique identifier of the feature.","pattern":"^[^<>\"'&]*$"},"isBundle":{"type":"boolean","description":"True if this is a feature group. Default is false."},"isEnabled":{"type":"boolean","description":"True if this feature is enabled. Default is true."},"name":{"type":"string","description":"This is the name for the feature.","pattern":"^[^<>\"'&]*$"},"constraint":{"type":"array","items":{"$ref":"#/definitions/ConstraintRef"},"description":"This is a list of feature constraints."},"featureCharacteristic":{"type":"array","items":{"$ref":"#/definitions/Characteristic"},"minItems":1,"description":"This is a list of Characteristics for a particular feature."},"featureRelationship":{"type":"array","items":{"$ref":"#/definitions/FeatureRelationship"}},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"}}},"BundledProductSpecification":{"type":"object","description":"A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.","properties":{"id":{"type":"string","description":"Unique identifier of the product specification","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the product specification"},"lifecycleStatus":{"type":"string","description":"Used to indicate the current lifecycle status","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"Name of the product specification","pattern":"^[^<>\"'&]*$"},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"the class type of the corresponding product specification"}}},"UsageSpecificationRef":{"type":"object","description":"Usage Specification reference.","required":["id"],"properties":{"@referredType":{"type":"string","description":"Generic attribute indicating the name of the class type of the referred resource entity.","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the Usage Specification."},"id":{"type":"string","description":"Unique identifier of the Usage Specification.","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"Name of the Usage Specification.","pattern":"^[^<>\"'&]*$"},"externalIdentifier":{"type":"array","items":{"$ref":"#/definitions/ExternalIdentifier"}}}},"ProductSpecType":{"type":"object","description":"Product Specification type.","required":["id","description"],"properties":{"id":{"type":"string","description":"Identifier of the Product Spec Type.","pattern":"^[^<>\"'&]*$"},"description":{"description":"Description of the Product Spec Type.","type":"string","pattern":"^[^<>\"'&]*$"}}},"ProductSpecCharacteristic":{"type":"object","description":"A characteristic quality or distinctive feature of a ProductSpecification.  The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.","properties":{"name":{"type":"string","description":"Name of the productSpecCharacteristic","pattern":"^[^<>\"'&]*$"},"description":{"type":"string","description":"A narrative that explains in detail what the productSpecCharacteristic is","pattern":"^[^<>\"'&]*$"},"valueType":{"type":"string","description":"A kind of value that the characteristic can take on, such as numeric, text and so forth","pattern":"^[^<>\"'&]*$"},"configurable":{"type":"boolean","description":"If true, the Boolean indicates that the productSpecCharacteristic is configurable"},"validFor":{"$ref":"#/definitions/TimePeriod","description":"The period for which the productSpecCharacteristic is valid"},"@type":{"type":"string","description":"the class type of this characteristic"},"@schemaLocation":{"type":"string","description":"hyperlink reference to the schema describing this characteristic"},"@valueSchemaLocation":{"type":"string","description":"This (optional) field provides a link to the schema describing the value type.","pattern":"^[^<>\"'&]*$"},"minCardinality":{"type":"integer","description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality"},"maxCardinality":{"type":"integer","description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality"},"isUnique":{"type":"boolean","description":"An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\""},"regex":{"type":"string","description":"A rule or principle represented in regular expression used to derive the value of a characteristic value","pattern":"^[^<>\"'&]*$"},"extensible":{"type":"boolean","description":"An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product"},"productSpecCharRelationship":{"type":"array","items":{"$ref":"#/definitions/ProductSpecCharRelationship"}},"productSpecCharacteristicValue":{"type":"array","items":{"$ref":"#/definitions/ProductSpecCharacteristicValue"}},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"}}},"ProductRef":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of a related entity.","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Reference of the related entity."},"name":{"type":"string","description":"Name of the related entity.","pattern":"^[^<>\"'&]*$"},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"},"@referredType":{"type":"string","description":"The actual type of the target instance when needed for disambiguation.","pattern":"^[^<>\"'&]*$"}},"required":["id"]},"ProductOfferingTermValueRef":{"properties":{"id":{"description":"Unique identifier of the ProductOfferingTermValue","type":"string","pattern":"^[^<>\"'&]*$"},"name":{"description":"Name of the ProductOfferingTermValue","type":"string","pattern":"^[^<>\"'&]*$"}}},"ProductOfferingTermRef":{"properties":{"id":{"description":"Unique identifier of the ProductOfferingTerm","type":"string","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Url used to reference the product offering term"},"@referredType":{"type":"string","description":"(Class) type of the referred product offering term","pattern":"^[^<>\"'&]*$"},"@type":{"type":"string","description":"(Class) type of the product offering term"}}},"ExternalIdentifier":{"properties":{"owner":{"type":"string","description":"Name of the external system that owns the entity.","examples":["SAP Billing System"],"pattern":"^[^<>\"'&]*$"},"externalIdentifierType":{"type":"string","description":"Type of the identification, typically would be the type of the entity within the external system","examples":["ProductOfferingPrice"],"pattern":"^[^<>\"'&]*$"},"id":{"type":"string","description":"Identification of the entity within the external system.","examples":["BS-5672"],"pattern":"^[^<>\"'&]*$"}}},"TargetServiceSchema":{"type":"object","description":"The reference object to the schema and type of target service which is described by service specification","required":["@schemaLocation","@type"],"properties":{"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","description":"This field provides a link to the schema describing the target service"},"@type":{"type":"string","description":"Class type of the target service"}}},"CharacteristicRelationship":{"type":"object","description":"Another Characteristic that is related to the current Characteristic;","properties":{"id":{"type":"string","description":"Unique identifier of the characteristic","pattern":"^[^<>\"'&]*$"},"relationshipType":{"type":"string","description":"The type of relationship","pattern":"^[^<>\"'&]*$"},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"}}},"OrderItemActionType":{"type":"string","description":"action to be performed on the product","enum":["add","modify","delete","noChange"]},"FeatureRelationship":{"type":"object","description":"Configuration feature","required":["name","relationshipType"],"properties":{"id":{"type":"string","description":"Unique identifier of the target feature.","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"This is the name of the target feature.","pattern":"^[^<>\"'&]*$"},"relationshipType":{"type":"string","description":"This is the type of the feature relationship.","pattern":"^[^<>\"'&]*$"},"validFor":{"$ref":"#/definitions/TimePeriod","description":"The period for which this feature relationship is valid."},"@baseType":{"type":"string","description":"When sub-classing, this defines the super-class","pattern":"^[^<>\"'&]*$"},"@schemaLocation":{"type":"string","format":"uri","description":"A URI to a JSON-Schema file that defines additional attributes and relationships"},"@type":{"type":"string","description":"When sub-classing, this defines the sub-class entity name"}}},"ConstraintRef":{"type":"object","description":"Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.","properties":{"id":{"type":"string","description":"reference id to the target constraint","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Hyperlink reference to the target constraint"},"version":{"type":"string","description":"constraint version","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"Name given to the constraint","pattern":"^[^<>\"'&]*$"},"@referredType":{"type":"string","description":"The (class) type of the referred constraint","pattern":"^[^<>\"'&]*$"}}},"ProductSpecCharRelationship":{"type":"object","description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.","properties":{"type":{"type":"string","description":"Type of relationship such as aggregation, migration, substitution, dependency, exclusivity","pattern":"^[^<>\"'&]*$"},"validFor":{"$ref":"#/definitions/TimePeriod","description":"The period for which the productSpecCharRelationship is valid"},"charSpecSeq":{"type":"integer","description":"The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications.\n\nFor example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third."},"id":{"type":"string","description":"the identifier of the associated product specification","pattern":"^[^<>\"'&]*$"},"name":{"type":"string","description":"Name of the target product specification characteristic","pattern":"^[^<>\"'&]*$"},"href":{"type":"string","description":"Hyperlink reference to the target product specification"},"@type":{"type":"string","description":"Class type of target product specification"}}},"ProductSpecCharacteristicValue":{"type":"object","description":"A number or text that can be assigned to a ProductSpecCharacteristic.","properties":{"id":{"description":"Represents id of the PSCV","type":"string","pattern":"^[^<>\"'&]*$"},"isDefault":{"type":"boolean","description":"Not Sent"},"unitOfMeasure":{"type":"string","description":"Could be minutes, GB...","pattern":"^[^<>\"'&]*$"},"validFor":{"description":"Not Sent","$ref":"#/definitions/TimePeriod"},"value":{"type":"string","description":"The value of characteristic.The type of value is determined by ‘valueType’ characteristic.","pattern":"^[^<>\"'&]*$"},"valueFrom":{"type":"string","description":"Not Sent","pattern":"^[^<>\"'&]*$"},"valueTo":{"type":"string","description":"Not Sent","pattern":"^[^<>\"'&]*$"},"valueType":{"type":"string","description":"A kind of value that the characteristic can take on, such as numeric, string, boolean.  ","pattern":"^[^<>\"'&]*$"},"rangeInterval":{"type":"string","description":"Not Sent","pattern":"^[^<>\"'&]*$"},"regex":{"type":"string","description":"Not Sent","pattern":"^[^<>\"'&]*$"},"@type":{"type":"string","description":"The class type of the characteristic value"},"@schemaLocation":{"type":"string","description":"Hyperlink reference to schema describing this object"}}}}}