{ "openapi": "3.0.0", "info": { "title": "ATT APIs based on TMF716 - Resource Reservation - MSISDN", "description": "TMF716 - Resource Reservation - MSISDN", "version": "v1" }, "paths": { "/healthz": { "get": { "description": "Health Check", "responses": { "200": { "description": "Success", "x-amf-mediaType": "application/json", "content": { "application/json": { "schema": { "example": { "application_name": "tmf716-resourceReservation-MSISDN", "message": "Application up and running" } } } } } } } }, "/resourceReservation": { "post": { "operationId": "createReservation", "description": "This operation creates a MSISDNReservation entity. (TMF 716)", "summary": "Create Reservation", "parameters": [ { "name": "@type", "description": "Set qualifier in request", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "MSISDN" ] } }, { "name": "Authorization", "description": "JWT Bearer Token. Token URL: https://login.microsoftonline.com/e741d71c-c6b6-47b0-803c-0f3b32b07556/oauth2/v2.0/token \r\n\r\n See example below.\r\n\r\n\ncurl --location --request POST 'https://login.microsoftonline.com/e741d71c-c6b6-47b0-803c-0f3b32b07556/oauth2/v2.0/token' \r\n --header 'Content-Type: application/x-www-form-urlencoded' \r\n --header 'Cookie: fpc=Aswi39iZZIlGtV66yM1qCANKExLGAQAAAOqRbtgOAAAA; stsservicecookie=estsfd; x-ms-gateway-slice=estsfd' \r\n --data-urlencode 'scope=api://testHarnessCustomersStage1/.default' \r\n --data-urlencode 'grant_type=client_credentials' \r\n --data-urlencode 'client_id=6bb2748d-d916-4534-5148-ee8f598e1e00' \r\n --data-urlencode 'client_secret=k_43YrZE2S2v9o6__e.KOKc_V4h__csa3M' \r\n\r\n Note: client id/secret are not the right ones - contact API provider, via 'Request Access' button to get the correct on", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "type": "string", "default": "application/json" } }, { "name": "X-ATT-CorrelationId", "description": "A GUID1 provided by the client that typically serves as a reference ID used to correlate client activity with transactions processed by the server. It is generally paired with the X-ATT-ConversationId to help with tracing and observability.", "required": false, "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "MSISDNReservation", "description": "The MSISDN Reservation to be created", "x-amf-examples": { "queryVanityRequest": { "displayName": "queryVanityRequest", "description": "For a given vanityNumber object, this service provides the capability to request a list of available numbers that can be assigned to the subscriber", "value": { "@type": "MSISDNReservation_Create", "billingAccountNumber": "123456789", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "QUERY", "relatedParty": [ { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "role": "Commission", "secondaryCode": "GHIJKL" } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "random": { "quantity": 2, "vanityNumber": { "npa": "630", "vanityPattern": "888" } } } } }, "querySequentialRequest": { "displayName": "querySequentialRequest", "description": "For a given sequential object, this service provides the capability to request a list of available numbers that can be assigned to the subscriber.", "value": { "@type": "MSISDNReservation_Create", "billingAccountNumber": "123456789", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "QUERY", "relatedParty": [ { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "role": "Commission", "secondaryCode": "GHIJKL" } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "sequential": { "quantity": 2 } } } }, "reserveRandomRequest": { "displayName": "reserveRandomRequest", "description": "This service provides the capability to reserve a block of subscriber numbers for a predetermined time period – 30 days for TLG markets (except SAN and HOU TDMA 120 days) & 180 days for CARE markets – from a list of available numbers.", "value": { "@type": "MSISDNReservation_Create", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "RESERVE", "relatedParty": [ { "@type": "Customer", "address": { "AddressLine1": "123 Widget Way", "City": "Springield", "Country": "US", "State": "GA", "Zip": { "zipCode": "29201", "zipCodeExtension": "9375" }, "fieldIndicator": false }, "businessName": "Widgets LLC", "contactName": { "firstName": "Frank", "lastName": "Widget" }, "id": "", "role": "Customer" }, { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "location": "ABC123", "role": "Commission", "salesRepresentative": "Wilson", "secondaryCode": "GHIJKL" } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "random": { "quantity": 2 } } } }, "reserveSpecificRequest": { "displayName": "reserveSpecificRequest", "description": "This service provides the capability to reserve a block of subscriber numbers for a predetermined time period – 30 days for TLG markets (except SAN and HOU TDMA 120 days) & 180 days for CARE markets – from a list of available numbers.", "value": { "@type": "MSISDNReservation_Create", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "RESERVE", "relatedParty": [ { "@type": "Customer", "address": { "AddressLine1": "123 Widget Way", "City": "Springield", "Country": "US", "State": "GA", "Zip": { "zipCode": "29201", "zipCodeExtension": "9375" }, "fieldIndicator": false }, "businessName": "Widgets LLC", "contactName": { "firstName": "Frank", "lastName": "Widget" }, "id": "", "role": "Customer" }, { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "location": "ABC123", "role": "Commission", "salesRepresentative": "Wilson", "secondaryCode": "GHIJKL" } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "specificNumber": "6308880101" } } } }, "type": "object", "required": [ "operationType" ], "properties": { "serviceArea": { "title": "serviceArea", "description": "The service area associated with this subscriber number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 12 }, "reservationItem": { "title": "reservationItem", "type": "array", "items": { "$ref": "#/components/schemas/ReservationItem" } }, "marketServiceInfo": { "title": "marketServiceInfo", "type": "object", "properties": { "serviceZipCode": { "title": "serviceZipCode", "description": "Service area zip code for primary subscriber - sets the service market/submarket..", "type": "string", "pattern": "^\\d{5}$" }, "billingMarket": { "title": "billingMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 3, "maxLength": 3 }, "billingSubMarket": { "title": "billingSubMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 1, "maxLength": 3 }, "localMarket": { "title": "localMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 4, "maxLength": 4 }, "billingSystemId": { "title": "billingSystemId", "description": "The service area associated with the subscriber number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 12 }, "productType": { "title": "productType", "description": "Equipment type (Cellular = C, GSM = G)", "enum": [ "C", "G" ], "type": "string" } } }, "channel": { "title": "channel", "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", "type": "object", "required": [ "id" ], "properties": { "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "Name of the channel.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "state": { "title": "state", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "type": "string" }, "storeId": { "title": "storeId", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "operationType": { "title": "operationType", "description": "Selects the reservation operation to be performed", "enum": [ "QUERY", "RESERVE", "RELEASE" ], "type": "string" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "cancellationReason": { "title": "cancellationReason", "description": "Reason why the reservation is cancelled.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "requestedStartDate": { "title": "requestedStartDate", "description": "Reservation fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow the reservation to begin before a specific date.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "equipmentType": { "title": "equipmentType", "description": "Equipment type (Cellular = C, GSM = G)", "enum": [ "C", "G" ], "type": "string" }, "subscriberNumberTypeSelector": { "title": "subscriberNumberTypeSelector", "type": "object", "properties": { "specificNumber": { "title": "subscriberNumber", "description": "The subscriber number being reserved.", "type": "string", "pattern": "^\\d{10}$" }, "random": { "title": "random", "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "title": "quantity", "description": "The quantity of subscriber numbers to reserve (1-5)", "type": "integer", "format": "int32", "minimum": 1, "maximum": 5 }, "vanityNumber": { "title": "vanityNumber", "type": "object", "required": [ "npa" ], "properties": { "npa": { "title": "npa", "description": "Also known as area code; the first 3 digits of the telephone number.", "type": "string", "pattern": "^\\d{3}$" }, "vanityPattern": { "title": "vanityPattern", "description": "Telephone number pattern for nxx and line number combinations ranging from 3 to 7 digits.", "type": "string", "pattern": "^\\d{3,7}$" } } } } }, "sequential": { "title": "sequential", "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "title": "quantity", "description": "The quantity of subscriber numbers to reserve (1-5)", "type": "integer", "format": "int32", "minimum": 1, "maximum": 5 } } } } }, "billingAccountNumber": { "title": "billingAccountNumber", "description": "The billingAccountNumber is only optional for Reseller partners. All other partners are required to send a billingAccountNumber.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "stateChangeReason": { "title": "stateChangeReason", "description": "The reason for changing the state", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "title": "relatedParty", "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRef" } }, "cancellationDate": { "title": "cancellationDate", "description": "Date when the reservation is cancelled.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedEntity": { "title": "relatedEntity", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntity" } }, "validFor": { "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "expectedCompletionDate": { "title": "expectedCompletionDate", "description": "Expected completion date amended by the provider", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "requestedCompletionDate": { "title": "requestedCompletionDate", "description": "Requested completion date from the requestor perspective", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "completionDate": { "title": "completionDate", "description": "Date when the reservation was completed", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "subscriptionClass": { "title": "subscriptionClass", "description": "Describes the class or category of subscriber. This element is required for OnStar reservations. Possible values S for GM and U for Audi", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "reservationPeriod": { "title": "reservationPeriod", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "stateChangeDate": { "title": "stateChangeDate", "description": "The date and time the state changed.", "type": "string", "format": "date-time" }, "commonOrderId": { "title": "commonOrderId", "description": "Id associated with direct fulfillment", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "creationDate": { "title": "creationDate", "description": "Date when the reservation was created", "type": "string", "format": "date-time" }, "description": { "title": "description", "description": "A string. free-text description of the reservation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } }, "x-amf-mediaType": "application/json" }, "responses": { "200": { "description": "Success", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "x-amf-examples": { "queryVanityResponse": { "displayName": "queryVanityResponse", "description": "API response for above \"queryVanityRequest\"", "value": { "@type": "MSISDNReservation", "billingAccountNumber": "123456789", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "QUERY", "relatedParty": [ { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "role": "Commission", "secondaryCode": "GHIJKL" } ], "reservationItem": [ { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068888080" } }, { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068880101" } } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "random": { "quantity": 2, "vanityNumber": { "npa": "630", "vanityPattern": "888" } } } } }, "querySequentialResponse": { "displayName": "querySequentialResponse", "description": "API response for above \"querySequentialRequest\"", "value": { "@type": "MSISDNReservation", "billingAccountNumber": "123456789", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "QUERY", "relatedParty": [ { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "role": "Commission", "secondaryCode": "GHIJKL" } ], "reservationItem": [ { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7062284400" } }, { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7062284401" } } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "sequential": { "quantity": 2 } } } }, "reserveRandomResponse": { "displayName": "reserveRandomResponse", "description": "API response for above \"reserveRandomRequest\"", "value": { "@type": "MSISDNReservation", "id": "666aa666-bb66-66cc-6d6d-ee66e66e66ee", "billingAccountNumber": "123456789", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "RESERVE", "relatedParty": [ { "@type": "Customer", "address": { "AddressLine1": "123 Widget Way", "City": "Springield", "Country": "US", "State": "GA", "Zip": { "zipCode": "29201", "zipCodeExtension": "9375" }, "fieldIndicator": false }, "businessName": "Widgets LLC", "contactName": { "firstName": "Frank", "lastName": "Widget" }, "id": "", "role": "Customer" }, { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "location": "ABC123", "role": "Commission", "salesRepresentative": "Wilson", "secondaryCode": "GHIJKL" } ], "reservationItem": [ { "@type": "MSISDNReservationItem", "isReserved": true, "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068250210" } }, { "@type": "MSISDNReservationItem", "isReserved": true, "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7063072881" } } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "random": { "quantity": 2 } } } }, "reserveSpecificResponse": { "displayName": "reserveSpecificResponse", "description": "API response for above \"reserveSpecificRequest\"", "value": { "@type": "MSISDNReservation", "id": "555aa555-bb55-55cc-5d5d-ee55e55e55ee", "billingAccountNumber": "123456789", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "RESERVE", "relatedParty": [ { "@type": "Customer", "address": { "AddressLine1": "123 Widget Way", "City": "Springield", "Country": "US", "State": "GA", "Zip": { "zipCode": "29201", "zipCodeExtension": "9375" }, "fieldIndicator": false }, "businessName": "Widgets LLC", "contactName": { "firstName": "Frank", "lastName": "Widget" }, "id": "", "role": "Customer" }, { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "location": "ABC123", "role": "Commission", "salesRepresentative": "Wilson", "secondaryCode": "GHIJKL" } ], "reservationItem": [ { "@type": "MSISDNReservationItem", "isReserved": true, "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068880101" } } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "specificNumber": "6308880101" } } } }, "type": "object", "required": [ "operationType" ], "properties": { "reservationItem": { "title": "reservationItem", "type": "array", "items": { "$ref": "#/components/schemas/ReservationItem" } }, "serviceArea": { "title": "serviceArea", "description": "The service area associated with this subscriber number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "marketServiceInfo": { "title": "marketServiceInfo", "type": "object", "properties": { "serviceZipCode": { "title": "serviceZipCode", "description": "Service area zip code for primary subscriber - sets the service market/submarket..", "type": "string", "pattern": "^\\d{5}$" }, "billingMarket": { "title": "billingMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 3, "maxLength": 3 }, "billingSubMarket": { "title": "billingSubMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 1, "maxLength": 3 }, "localMarket": { "title": "localMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 4, "maxLength": 4 }, "billingSystemId": { "title": "billingSystemId", "description": "The service area associated with the subscriber number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 12 }, "productType": { "title": "productType", "description": "Equipment type (Cellular = C, GSM = G)", "enum": [ "C", "G" ], "type": "string" } } }, "channel": { "title": "channel", "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", "type": "object", "required": [ "id" ], "properties": { "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "Name of the channel.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "state": { "title": "state", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "type": "string" }, "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "storeId": { "title": "storeId", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "operationType": { "title": "operationType", "description": "Selects the reservation operation performed", "enum": [ "QUERY", "RESERVE", "RELEASE" ], "type": "string" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "cancellationReason": { "title": "cancellationReason", "description": "Reason why the reservation is cancelled.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "requestedStartDate": { "title": "requestedStartDate", "description": "Reservation fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow the reservation to begin before a specific date.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "equipmentType": { "title": "equipmentType", "description": "Equipment type (Cellular = C, GSM = G)", "enum": [ "C", "G" ], "type": "string" }, "subscriberNumberTypeSelector": { "title": "subscriberNumberTypeSelector", "type": "object", "properties": { "specificNumber": { "title": "subscriberNumber", "description": "The subscriber number being reserved.", "type": "string", "pattern": "^\\d{10}$" }, "random": { "title": "random", "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "title": "quantity", "description": "The quantity of subscriber numbers to reserve (1-5)", "type": "integer", "format": "int32", "minimum": 1, "maximum": 5 }, "vanityNumber": { "title": "vanityNumber", "type": "object", "required": [ "npa" ], "properties": { "npa": { "title": "npa", "description": "Also known as area code; the first 3 digits of the telephone number.", "type": "string", "pattern": "^\\d{3}$" }, "vanityPattern": { "title": "vanityPattern", "description": "Telephone number pattern for nxx and line number combinations ranging from 3 to 7 digits.", "type": "string", "pattern": "^\\d{3,7}$" } } } } }, "sequential": { "title": "sequential", "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "title": "quantity", "description": "The quantity of subscriber numbers to reserve (1-5)", "type": "integer", "format": "int32", "minimum": 1, "maximum": 5 } } } } }, "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingAccountNumber": { "title": "billingAccountNumber", "description": "The billingAccountNumber is only optional for Reseller partners. All other partners are required to send a billingAccountNumber.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "stateChangeReason": { "title": "stateChangeReason", "description": "The reason for changing the state", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "title": "relatedParty", "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRef" } }, "cancellationDate": { "title": "cancellationDate", "description": "Date when the reservation is cancelled.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedEntity": { "title": "relatedEntity", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntity" } }, "validFor": { "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "expectedCompletionDate": { "title": "expectedCompletionDate", "description": "Expected completion date amended by the provider", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "requestedCompletionDate": { "title": "requestedCompletionDate", "description": "Requested completion date from the requestor perspective", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "completionDate": { "title": "completionDate", "description": "Date when the reservation was completed", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "subscriptionClass": { "title": "subscriptionClass", "description": "Describes the class or category of subscriber. This element is required for OnStar reservations. Possible values S for GM and U for Audi", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "reservationPeriod": { "title": "reservationPeriod", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "stateChangeDate": { "title": "stateChangeDate", "description": "The date and time the state changed.", "type": "string", "format": "date-time" }, "commonOrderId": { "title": "commonOrderId", "description": "Id associated with direct fulfillment", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "creationDate": { "title": "creationDate", "description": "Date when the reservation was created", "type": "string", "format": "date-time" }, "description": { "title": "description", "description": "A string. free-text description of the reservation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } }, "application/json": { "schema": { "title": "response", "description": "", "x-amf-examples": { "queryVanityResponse": { "displayName": "queryVanityResponse", "description": "API response for above \"queryVanityRequest\"", "value": { "@type": "MSISDNReservation", "billingAccountNumber": "123456789", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "QUERY", "relatedParty": [ { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "role": "Commission", "secondaryCode": "GHIJKL" } ], "reservationItem": [ { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068888080" } }, { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068880101" } } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "random": { "quantity": 2, "vanityNumber": { "npa": "630", "vanityPattern": "888" } } } } }, "querySequentialResponse": { "displayName": "querySequentialResponse", "description": "API response for above \"querySequentialRequest\"", "value": { "@type": "MSISDNReservation", "billingAccountNumber": "123456789", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "QUERY", "relatedParty": [ { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "role": "Commission", "secondaryCode": "GHIJKL" } ], "reservationItem": [ { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7062284400" } }, { "@type": "MSISDNReservationItem", "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7062284401" } } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "sequential": { "quantity": 2 } } } }, "reserveRandomResponse": { "displayName": "reserveRandomResponse", "description": "API response for above \"reserveRandomRequest\"", "value": { "@type": "MSISDNReservation", "id": "666aa666-bb66-66cc-6d6d-ee66e66e66ee", "billingAccountNumber": "123456789", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "RESERVE", "relatedParty": [ { "@type": "Customer", "address": { "AddressLine1": "123 Widget Way", "City": "Springield", "Country": "US", "State": "GA", "Zip": { "zipCode": "29201", "zipCodeExtension": "9375" }, "fieldIndicator": false }, "businessName": "Widgets LLC", "contactName": { "firstName": "Frank", "lastName": "Widget" }, "id": "", "role": "Customer" }, { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "location": "ABC123", "role": "Commission", "salesRepresentative": "Wilson", "secondaryCode": "GHIJKL" } ], "reservationItem": [ { "@type": "MSISDNReservationItem", "isReserved": true, "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068250210" } }, { "@type": "MSISDNReservationItem", "isReserved": true, "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7063072881" } } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "random": { "quantity": 2 } } } }, "reserveSpecificResponse": { "displayName": "reserveSpecificResponse", "description": "API response for above \"reserveSpecificRequest\"", "value": { "@type": "MSISDNReservation", "id": "555aa555-bb55-55cc-5d5d-ee55e55e55ee", "billingAccountNumber": "123456789", "equipmentType": "G", "marketServiceInfo": { "productType": "G", "serviceZipCode": "29201" }, "operationType": "RESERVE", "relatedParty": [ { "@type": "Customer", "address": { "AddressLine1": "123 Widget Way", "City": "Springield", "Country": "US", "State": "GA", "Zip": { "zipCode": "29201", "zipCodeExtension": "9375" }, "fieldIndicator": false }, "businessName": "Widgets LLC", "contactName": { "firstName": "Frank", "lastName": "Widget" }, "id": "", "role": "Customer" }, { "@type": "Commission", "dealerCode": "ABCDEF", "id": "", "location": "ABC123", "role": "Commission", "salesRepresentative": "Wilson", "secondaryCode": "GHIJKL" } ], "reservationItem": [ { "@type": "MSISDNReservationItem", "isReserved": true, "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "7068880101" } } ], "serviceArea": "123456789012", "subscriberNumberTypeSelector": { "specificNumber": "6308880101" } } } }, "type": "object", "required": [ "operationType" ], "properties": { "reservationItem": { "title": "reservationItem", "type": "array", "items": { "$ref": "#/components/schemas/ReservationItem" } }, "serviceArea": { "title": "serviceArea", "description": "The service area associated with this subscriber number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "marketServiceInfo": { "title": "marketServiceInfo", "type": "object", "properties": { "serviceZipCode": { "title": "serviceZipCode", "description": "Service area zip code for primary subscriber - sets the service market/submarket..", "type": "string", "pattern": "^\\d{5}$" }, "billingMarket": { "title": "billingMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 3, "maxLength": 3 }, "billingSubMarket": { "title": "billingSubMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 1, "maxLength": 3 }, "localMarket": { "title": "localMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 4, "maxLength": 4 }, "billingSystemId": { "title": "billingSystemId", "description": "The service area associated with the subscriber number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 12 }, "productType": { "title": "productType", "description": "Equipment type (Cellular = C, GSM = G)", "enum": [ "C", "G" ], "type": "string" } } }, "channel": { "title": "channel", "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", "type": "object", "required": [ "id" ], "properties": { "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "Name of the channel.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "state": { "title": "state", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "type": "string" }, "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "storeId": { "title": "storeId", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "operationType": { "title": "operationType", "description": "Selects the reservation operation performed", "enum": [ "QUERY", "RESERVE", "RELEASE" ], "type": "string" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "cancellationReason": { "title": "cancellationReason", "description": "Reason why the reservation is cancelled.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "requestedStartDate": { "title": "requestedStartDate", "description": "Reservation fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow the reservation to begin before a specific date.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "equipmentType": { "title": "equipmentType", "description": "Equipment type (Cellular = C, GSM = G)", "enum": [ "C", "G" ], "type": "string" }, "subscriberNumberTypeSelector": { "title": "subscriberNumberTypeSelector", "type": "object", "properties": { "specificNumber": { "title": "subscriberNumber", "description": "The subscriber number being reserved.", "type": "string", "pattern": "^\\d{10}$" }, "random": { "title": "random", "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "title": "quantity", "description": "The quantity of subscriber numbers to reserve (1-5)", "type": "integer", "format": "int32", "minimum": 1, "maximum": 5 }, "vanityNumber": { "title": "vanityNumber", "type": "object", "required": [ "npa" ], "properties": { "npa": { "title": "npa", "description": "Also known as area code; the first 3 digits of the telephone number.", "type": "string", "pattern": "^\\d{3}$" }, "vanityPattern": { "title": "vanityPattern", "description": "Telephone number pattern for nxx and line number combinations ranging from 3 to 7 digits.", "type": "string", "pattern": "^\\d{3,7}$" } } } } }, "sequential": { "title": "sequential", "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "title": "quantity", "description": "The quantity of subscriber numbers to reserve (1-5)", "type": "integer", "format": "int32", "minimum": 1, "maximum": 5 } } } } }, "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingAccountNumber": { "title": "billingAccountNumber", "description": "The billingAccountNumber is only optional for Reseller partners. All other partners are required to send a billingAccountNumber.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "stateChangeReason": { "title": "stateChangeReason", "description": "The reason for changing the state", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "title": "relatedParty", "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRef" } }, "cancellationDate": { "title": "cancellationDate", "description": "Date when the reservation is cancelled.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedEntity": { "title": "relatedEntity", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntity" } }, "validFor": { "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "expectedCompletionDate": { "title": "expectedCompletionDate", "description": "Expected completion date amended by the provider", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "requestedCompletionDate": { "title": "requestedCompletionDate", "description": "Requested completion date from the requestor perspective", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "completionDate": { "title": "completionDate", "description": "Date when the reservation was completed", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "subscriptionClass": { "title": "subscriptionClass", "description": "Describes the class or category of subscriber. This element is required for OnStar reservations. Possible values S for GM and U for Audi", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "reservationPeriod": { "title": "reservationPeriod", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "stateChangeDate": { "title": "stateChangeDate", "description": "The date and time the state changed.", "type": "string", "format": "date-time" }, "commonOrderId": { "title": "commonOrderId", "description": "Id associated with direct fulfillment", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "creationDate": { "title": "creationDate", "description": "Date when the reservation was created", "type": "string", "format": "date-time" }, "description": { "title": "description", "description": "A string. free-text description of the reservation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "400": { "description": "Bad Request", "x-amf-mediaType": "application/json", "x-amf-responsePayloads": [ { "mediaType": "application/json;charset=utf-8", "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "status", "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } ], "content": { "application/json;charset=utf-8": { "schema": { "example": { "code": "400", "reason": "JWT Token is required", "message": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF716" } } }, "application/json": { "schema": { "example": { "code": "400", "reason": "JWT Token is required", "message": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF716" } } } } }, "401": { "description": "Unauthorized", "x-amf-mediaType": "application/json", "x-amf-responsePayloads": [ { "mediaType": "application/json;charset=utf-8", "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "status", "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } ], "content": { "application/json;charset=utf-8": { "schema": { "example": { "code": "401", "reason": "Invalid token", "message": "Invalid token", "status": "401-UNAUTHORIZED-TMF716" } } }, "application/json": { "schema": { "example": { "code": "401", "reason": "Invalid token", "message": "Invalid token", "status": "401-UNAUTHORIZED-TMF716" } } } } }, "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", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "status", "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } }, "application/json": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "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", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "status", "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } }, "application/json": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "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", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "status", "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } }, "application/json": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "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", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "status", "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } }, "application/json": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "status", "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "503": { "description": "Error communicating with JWKS server.", "x-amf-mediaType": "application/json", "content": { "application/json;charset=utf-8": { "schema": { "example": { "code": "503", "reason": "Internal Server Error", "message": "Internal Server Error", "status": "503-INTERNAL SERVER_ERROR-TMF716" } } }, "application/json": { "schema": { "example": { "code": "503", "reason": "Internal Server Error", "message": "Internal Server Error", "status": "503-INTERNAL SERVER_ERROR-TMF716" } } } } } } } }, "/resourceReservation/{id}": { "patch": { "operationId": "patchMSISDNReservation", "description": "This operation updates partially a MSISDNReservation entity. (TMF 716)", "summary": "Patch MSISDN Reservation", "parameters": [ { "name": "@type", "description": "Set qualifier in request", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "MSISDN" ] } }, { "name": "id", "description": "Identifier of the MSISDNReservation returned during Resource Reservation API POST call. (operationType:RESERVE)", "required": true, "in": "path", "schema": { "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "MSISDNReservation", "description": "The ResourceReservation to be updated", "x-amf-examples": { "releaseRequest": { "displayName": "releaseRequest", "description": "This service enables clients to release previously reserved subscriber number. All subscriber numbers must be in a pre-activation/reserved state, or else an error will be returned to the client", "value": { "@type": "MSISDNReservation_Update", "marketServiceInfo": { "billingMarket": "ABC", "billingSubMarket": "DEF" }, "operationType": "RELEASE", "reservationItem": [ { "@type": "MSISDNReservationItem", "action": "delete", "resource": { "@type": "MSISDN", "value": "5466231488" } } ] } } }, "type": "object", "required": [ "operationType" ], "properties": { "serviceArea": { "title": "serviceArea", "description": "The service area associated with this subscriber number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "reservationItem": { "title": "reservationItem", "type": "array", "items": { "$ref": "#/components/schemas/ReservationItem" } }, "marketServiceInfo": { "title": "marketServiceInfo", "type": "object", "properties": { "serviceZipCode": { "title": "serviceZipCode", "description": "Service area zip code for primary subscriber - sets the service market/submarket..", "type": "string", "pattern": "^\\d{5}$" }, "billingMarket": { "title": "billingMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 3, "maxLength": 3 }, "billingSubMarket": { "title": "billingSubMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 1, "maxLength": 3 }, "localMarket": { "title": "localMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 4, "maxLength": 4 }, "billingSystemId": { "title": "billingSystemId", "description": "The service area associated with the subscriber number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 12 }, "productType": { "title": "productType", "description": "Equipment type (Cellular = C, GSM = G)", "enum": [ "C", "G" ], "type": "string" } } }, "channel": { "title": "channel", "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", "type": "object", "required": [ "id" ], "properties": { "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "Name of the channel.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "state": { "title": "state", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "type": "string" }, "storeId": { "title": "storeId", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "operationType": { "title": "operationType", "description": "Selects the reservation operation to be performed", "enum": [ "QUERY", "RESERVE", "RELEASE" ], "type": "string" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "cancellationReason": { "title": "cancellationReason", "description": "Reason why the reservation is cancelled.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "requestedStartDate": { "title": "requestedStartDate", "description": "Reservation fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow the reservation to begin before a specific date.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "equipmentType": { "title": "equipmentType", "description": "Equipment type (Cellular = C, GSM = G)", "enum": [ "C", "G" ], "type": "string" }, "subscriberNumberTypeSelector": { "title": "subscriberNumberTypeSelector", "type": "object", "properties": { "specificNumber": { "title": "subscriberNumber", "description": "The subscriber number being reserved.", "type": "string", "pattern": "^\\d{10}$" }, "random": { "title": "random", "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "title": "quantity", "description": "The quantity of subscriber numbers to reserve (1-5)", "type": "integer", "format": "int32", "minimum": 1, "maximum": 5 }, "vanityNumber": { "title": "vanityNumber", "type": "object", "required": [ "npa" ], "properties": { "npa": { "title": "npa", "description": "Also known as area code; the first 3 digits of the telephone number.", "type": "string", "pattern": "^\\d{3}$" }, "vanityPattern": { "title": "vanityPattern", "description": "Telephone number pattern for nxx and line number combinations ranging from 3 to 7 digits.", "type": "string", "pattern": "^\\d{3,7}$" } } } } }, "sequential": { "title": "sequential", "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "title": "quantity", "description": "The quantity of subscriber numbers to reserve (1-5)", "type": "integer", "format": "int32", "minimum": 1, "maximum": 5 } } } } }, "billingAccountNumber": { "title": "billingAccountNumber", "description": "The billingAccountNumber is only optional for Reseller partners. All other partners are required to send a billingAccountNumber.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "stateChangeReason": { "title": "stateChangeReason", "description": "The reason for changing the state", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "title": "relatedParty", "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRef" } }, "cancellationDate": { "title": "cancellationDate", "description": "Date when the reservation is cancelled.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedEntity": { "title": "relatedEntity", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntity" } }, "validFor": { "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "expectedCompletionDate": { "title": "expectedCompletionDate", "description": "Expected completion date amended by the provider", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "requestedCompletionDate": { "title": "requestedCompletionDate", "description": "Requested completion date from the requestor perspective", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "completionDate": { "title": "completionDate", "description": "Date when the reservation was completed", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "subscriptionClass": { "title": "subscriptionClass", "description": "Describes the class or category of subscriber. This element is required for OnStar reservations. Possible values S for GM and U for Audi", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "reservationPeriod": { "title": "reservationPeriod", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "stateChangeDate": { "title": "stateChangeDate", "description": "The date and time the state changed.", "type": "string", "format": "date-time" }, "commonOrderId": { "title": "commonOrderId", "description": "Id associated with direct fulfillment", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "creationDate": { "title": "creationDate", "description": "Date when the reservation was created", "type": "string", "format": "date-time" }, "description": { "title": "description", "description": "A string. free-text description of the reservation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } }, "x-amf-mediaType": "application/json" }, "responses": { "200": { "description": "Updated", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "This operation updates partially a MSISDNReservation entity.", "x-amf-examples": { "releaseResponse": { "displayName": "releaseResponse", "description": "API response for above \"releaseRequest\"", "value": { "@type": "MSISDNReservation", "billingAccountNumber": "123456789", "marketServiceInfo": { "billingMarket": "ABC", "billingSubMarket": "DEF" }, "operationType": "RELEASE", "reservationItem": [ { "@type": "MSISDNReservationItem", "isReleased": true, "resource": { "@type": "MSISDN", "equipmentType": "G", "serviceArea": "123456789012", "value": "5466231488" } } ] } } }, "type": "object", "required": [ "operationType" ], "properties": { "reservationItem": { "title": "reservationItem", "type": "array", "items": { "$ref": "#/components/schemas/ReservationItem" } }, "serviceArea": { "title": "serviceArea", "description": "The service area associated with this subscriber number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "marketServiceInfo": { "title": "marketServiceInfo", "type": "object", "properties": { "serviceZipCode": { "title": "serviceZipCode", "description": "Service area zip code for primary subscriber - sets the service market/submarket..", "type": "string", "pattern": "^\\d{5}$" }, "billingMarket": { "title": "billingMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 3, "maxLength": 3 }, "billingSubMarket": { "title": "billingSubMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 1, "maxLength": 3 }, "localMarket": { "title": "localMarket", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 4, "maxLength": 4 }, "billingSystemId": { "title": "billingSystemId", "description": "The service area associated with the subscriber number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 12 }, "productType": { "title": "productType", "description": "Equipment type (Cellular = C, GSM = G)", "enum": [ "C", "G" ], "type": "string" } } }, "channel": { "title": "channel", "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", "type": "object", "required": [ "id" ], "properties": { "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "Name of the channel.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "state": { "title": "state", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "type": "string" }, "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "storeId": { "title": "storeId", "description": "StoreId for CreditEvaluation purpose in TLG CAS", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "operationType": { "title": "operationType", "description": "Selects the reservation operation performed", "enum": [ "QUERY", "RESERVE", "RELEASE" ], "type": "string" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "cancellationReason": { "title": "cancellationReason", "description": "Reason why the reservation is cancelled.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "requestedStartDate": { "title": "requestedStartDate", "description": "Reservation fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow the reservation to begin before a specific date.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "equipmentType": { "title": "equipmentType", "description": "Equipment type (Cellular = C, GSM = G)", "enum": [ "C", "G" ], "type": "string" }, "subscriberNumberTypeSelector": { "title": "subscriberNumberTypeSelector", "type": "object", "properties": { "specificNumber": { "title": "subscriberNumber", "description": "The subscriber number being reserved.", "type": "string", "pattern": "^\\d{10}$" }, "random": { "title": "random", "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "title": "quantity", "description": "The quantity of subscriber numbers to reserve (1-5)", "type": "integer", "format": "int32", "minimum": 1, "maximum": 5 }, "vanityNumber": { "title": "vanityNumber", "type": "object", "required": [ "npa" ], "properties": { "npa": { "title": "npa", "description": "Also known as area code; the first 3 digits of the telephone number.", "type": "string", "pattern": "^\\d{3}$" }, "vanityPattern": { "title": "vanityPattern", "description": "Telephone number pattern for nxx and line number combinations ranging from 3 to 7 digits.", "type": "string", "pattern": "^\\d{3,7}$" } } } } }, "sequential": { "title": "sequential", "type": "object", "required": [ "quantity" ], "properties": { "quantity": { "title": "quantity", "description": "The quantity of subscriber numbers to reserve (1-5)", "type": "integer", "format": "int32", "minimum": 1, "maximum": 5 } } } } }, "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "billingAccountNumber": { "title": "billingAccountNumber", "description": "The billingAccountNumber is only optional for Reseller partners. All other partners are required to send a billingAccountNumber.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "stateChangeReason": { "title": "stateChangeReason", "description": "The reason for changing the state", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedParty": { "title": "relatedParty", "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRef" } }, "cancellationDate": { "title": "cancellationDate", "description": "Date when the reservation is cancelled.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "relatedEntity": { "title": "relatedEntity", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntity" } }, "validFor": { "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "expectedCompletionDate": { "title": "expectedCompletionDate", "description": "Expected completion date amended by the provider", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "requestedCompletionDate": { "title": "requestedCompletionDate", "description": "Requested completion date from the requestor perspective", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "completionDate": { "title": "completionDate", "description": "Date when the reservation was completed", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "subscriptionClass": { "title": "subscriptionClass", "description": "Describes the class or category of subscriber. This element is required for OnStar reservations. Possible values S for GM and U for Audi", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "reservationPeriod": { "title": "reservationPeriod", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "stateChangeDate": { "title": "stateChangeDate", "description": "The date and time the state changed.", "type": "string", "format": "date-time" }, "commonOrderId": { "title": "commonOrderId", "description": "Id associated with direct fulfillment", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "creationDate": { "title": "creationDate", "description": "Date when the reservation was created", "type": "string", "format": "date-time" }, "description": { "title": "description", "description": "A string. free-text description of the reservation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@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", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "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", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "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", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "status", "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }, "404": { "description": "Not Found", "x-amf-mediaType": "application/json;charset=utf-8", "content": { "application/json;charset=utf-8": { "schema": { "title": "response", "description": "", "type": "object", "required": [ "reason", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "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", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "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", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "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", "code" ], "properties": { "reason": { "title": "reason", "description": "Explanation of the reason for the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "code": { "title": "code", "description": "Application relevant detail, defined in the API or a common list.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "referenceError": { "title": "referenceError", "description": "URI of documentation describing the error.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class entity name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "message": { "title": "message", "description": "More details and corrective actions related to the error which can be shown to a client user.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "status": { "title": "status", "description": "HTTP Error code extension", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } } } } } }, "components": { "schemas": { "ReservationItem": { "title": "ReservationItem", "description": "An identified part of the reservation. A reservation is decomposed into one or more reservation items.", "type": "object", "properties": { "id": { "title": "id", "description": "A string. Identifier of the item.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32" }, "stateChangeDate": { "title": "stateChangeDate", "description": "The date and time the state changed.", "type": "string", "format": "date-time" }, "stateChangeReason": { "title": "stateChangeReason", "description": "The reason for changing the state", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "action": { "title": "action", "description": "action to be performed on the entity", "enum": [ "add", "modify", "delete", "noChange" ], "type": "string" }, "appliedCapacity": { "title": "appliedCapacity", "description": "Specific ability of an entity measured in quantity and units of quantity over an extended period.", "type": "object", "properties": { "plannedOrActualCapacity": { "title": "plannedOrActualCapacity", "description": "An indicator that specifies whether the capacity is planned or actual.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "applicableTimePeriod": { "title": "applicableTimePeriod", "description": "The period of time for which Capacity or CapacityDemand applies.", "type": "array", "items": { "$ref": "#/components/schemas/ApplicableTimePeriod" } }, "capacityAmount": { "title": "capacityAmount", "description": "Quantity that defines the Capacity.", "type": "object", "properties": { "capacityAmount": { "title": "capacityAmount", "description": "A value and units that define the CapacityAmount, such as 10000 ea, 10B Mb. Instance values are mutually exclusive with From and To capacityAmounts and range interval.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "capacityAmountFrom": { "title": "capacityAmountFrom", "description": "The low range value that a Capacity Amount can take on.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "capacityAmountTo": { "title": "capacityAmountTo", "description": "The upper range value that CapacityAmount can take on.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "rangeInterval": { "title": "rangeInterval", "description": "An indicator that specifies the inclusion or exclusion of the capacityAmount From and capacityAmountTo attributes. \r\nPossible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\".", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "capacitySpec": { "title": "capacitySpec", "type": "object", "required": [ "id" ], "properties": { "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "place": { "title": "place", "description": "A place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", "type": "object", "properties": { "id": { "title": "id", "description": "Unique identifier of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "title": "href", "description": "Unique reference of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "relatedCapacity": { "title": "relatedCapacity", "description": "related capacity.", "type": "array", "items": { "$ref": "#/components/schemas/CapacityRef" } }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "capacityDemand": { "title": "capacityDemand", "description": "Specific ability of an entity measured in quantity and units of quantity over an extended period.", "type": "object", "properties": { "plannedOrActualCapacity": { "title": "plannedOrActualCapacity", "description": "An indicator that specifies whether the capacity is planned or actual.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "applicableTimePeriod": { "title": "applicableTimePeriod", "description": "The period of time for which Capacity or CapacityDemand applies.", "type": "array", "items": { "$ref": "#/components/schemas/ApplicableTimePeriod" } }, "capacityAmount": { "title": "capacityAmount", "description": "Quantity that defines the Capacity.", "type": "object", "properties": { "capacityAmount": { "title": "capacityAmount", "description": "A value and units that define the CapacityAmount, such as 10000 ea, 10B Mb. Instance values are mutually exclusive with From and To capacityAmounts and range interval.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "capacityAmountFrom": { "title": "capacityAmountFrom", "description": "The low range value that a Capacity Amount can take on.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "capacityAmountTo": { "title": "capacityAmountTo", "description": "The upper range value that CapacityAmount can take on.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "rangeInterval": { "title": "rangeInterval", "description": "An indicator that specifies the inclusion or exclusion of the capacityAmount From and capacityAmountTo attributes. \r\nPossible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\".", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "capacitySpec": { "title": "capacitySpec", "type": "object", "required": [ "id" ], "properties": { "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "place": { "title": "place", "description": "A place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", "type": "object", "properties": { "id": { "title": "id", "description": "Unique identifier of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "title": "href", "description": "Unique reference of the place", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "relatedCapacity": { "title": "relatedCapacity", "description": "related capacity.", "type": "array", "items": { "$ref": "#/components/schemas/CapacityRef" } }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "relatedEntity": { "title": "relatedEntity", "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntity" } }, "relatedParty": { "title": "relatedParty", "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRef" } }, "reservationPeriod": { "title": "reservationPeriod", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "state": { "title": "state", "enum": [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation" ], "type": "string" }, "validFor": { "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "RelatedPartyRef": { "title": "RelatedPartyRef", "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.", "type": "object", "required": [ "id" ], "properties": { "creditCheckAgent": { "title": "creditCheckAgent", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "title": "href", "description": "Reference of the related party, could be a party reference or a party role reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "affiliateSalesRepCode": { "title": "affiliateSalesRepCode", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "customerCode": { "title": "customerCode", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "Name of the related party", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "address": { "title": "address", "description": "Manditory Fields Field Name Case when Mandatory city Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. stateCode Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. zip Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'. pob Mandatory only when Address type = 'P.O. Box'. streetName Mandatory only when Address type = 'Street'.", "type": "object", "properties": { "fieldIndicator": { "title": "fieldIndicator", "description": "In the request, specifies whether the address validation should take place. If true or not provided, the validation will take place. If false, the validation will be bypassed. In the response, indicates whether the address was reformatted during the validation.", "type": "boolean" }, "incorporatedIndicator": { "title": "incorporatedIndicator", "description": "Incorporated indicator retrieved from Vertex", "type": "boolean" }, "AddressLine1": { "title": "AddressLine1", "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 120 }, "AddressLine2": { "title": "AddressLine2", "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 120 }, "UrbanizationCode": { "title": "UrbanizationCode", "description": "An urbanization denotes an area, sector, or residential development within a geographic area. In addition to being a descriptive word, it precedes the name of that area. This descriptor, commonly used in Puerto Rican urban areas, is an important part of the addressing format as it describes the location of a given street.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 30 }, "lastUpdate": { "title": "lastUpdate", "description": "Designates a date/time stamp in UTC format. The following formats are accepted: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss.xxxZ Where : - YYYY indicates the year - MM indicates the month - DD indicates the day - T is a fixed character, indicating the time section - hh indicates the hour, zero pre-pended - mm indicates the minute, zero pre-pended - ss indicates the second, zero pre-pended - xxx indicates the millisecond, zero pre-pended - Z is a fixed character, indicating UTC time zone", "type": "string", "pattern": "^.+T.+Z$" }, "addressSubType": { "title": "addressSubType", "description": "This attribute contains the address type: Street (regular) address=S, Military=M, POB address=P, Rural address=R, Foreign=F", "enum": [ "S", "M", "P", "R", "F" ], "type": "string" }, "ruralAddressAttention": { "title": "ruralAddressAttention", "description": "Not all systems will be able to accept or return this number of characters for an address line. Some Cingular systems are more restrictive on address line length than what is shown here.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 120 }, "internationalAddressLine": { "title": "internationalAddressLine", "description": "International address Line 1 of an International address which includes street number, street name, etc. Required if address subtype is 'F'", "type": "string", "pattern": "^[?-~ -%'-;=]{0,255}$", "maxLength": 255 }, "internationalZip": { "title": "internationalZip", "description": "This should be populated when the addressSubType is F Foreign\\International", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "addressType": { "title": "addressType", "description": "This attribute contains the address type: Street (regular) address=S, Military=M, POB address=P, Rural address=R, Foreign=F", "enum": [ "S", "M", "P", "R", "F" ], "type": "string" }, "Attention": { "title": "Attention", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 25 }, "Street": { "title": "Street", "type": "object", "required": [ "streetName", "streetNumber" ], "properties": { "streetName": { "title": "streetName", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 50 }, "streetDirection": { "title": "streetDirection", "description": "The address street direction (east, west. etc.): EAST=E, NORTH=N, NORTH EAST=NE, NORTH WEST=NW, SOUTH=S, SOUTH EAST= SE, SOUTH WEST=SW, WEST=W.", "enum": [ "E", "N", "NE", "NW", "S", "SE", "SW", "W" ], "type": "string" }, "streetNumber": { "title": "streetNumber", "description": "The address house number number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 10 }, "streetTrailingDirection": { "title": "streetTrailingDirection", "description": "The address trailing street direction (east, west. etc.). East - E, North - N, North East - NE, North West - NW, South - S, South East - SE, South West - SW, West - W", "enum": [ "E", "N", "NE", "W", "NW", "S", "SE", "SW" ], "type": "string" }, "streetType": { "title": "streetType", "description": "The street type, e.g., Street, Avenue, Grove, etc. to be checked against a decoding table: ALLEY=ALY,ANNEX=ANX,ARCADE=ARC,AVENUE=AVE,BAYOU=BYU,BEACH=BCH,BEND=BND,BLUFF=BLF,BLUFFS=BLFS, BOTTOM=BTM,BOULEVARD=BLVD,BRANCH=BR,BRIDGE=BRG,BROOK=BRK,BROOKS=BRKS,BURG=BG,BURGS=BGS, BYPASS=BYP,CAMP=CP,CANYON=CYN,CAPE=CPE,CAUSEWAY=CSWY,CENTER=CTR,CENTERS=CTRS,CIRCLE=CIR, CIRCLES=CIRS,CLIFF=CLF,CLIFFS=CLFS,CLUB=CLB,COMMON=CMN,CORNER=COR,CORNERS=CORS,COURSE=CRSE, COURT=CT,COURTS=CTS,COVE=CV,COVES=CVS,CREEK=CRK,CRESENT=CRES,CREST=CRST,CROSSING=XING, CROSSROAD=XRD,CURVE=CURV,DALE=DL,DAM=DM,DIVIDE=DV,DRIVE=DR,DRIVES=DRS,ESTATE=EST,ESTATES=ESTS ,EXPRESSWAY=EXPY,EXTENSION=EXT,EXTENSIONS=EXTS,FALL=FALL,FALLS=FLS,FERRY=FRY,FIELD=FLD,FIELDS=FLDS, FLAT=FLT,FLATS=FLTS,FORD=FRD,FORDS=FRDS,FOREST=FRST,FORGE=FRG,FORGES=FRGS,FORK=FRK,FORKS=FRKS, FORT=FT,FREEWAY=FWY,GARDEN=GDN,GARDENS=GDNS,GARDENS=GDNS,GATEWAY=GTWY,GLEN=GLN,GLENS=GLNS, GREEN=GRN,GREENS=GRNS,GROVE=GRV,GROVES=GRVS,HARBOR=HBR,HARBORS=HBRS,HAVEN=HVN,HEIGHTS=HTS, HIGHWAY=HWY,HILL=HL,HILLS=HLS,HOLLOW=HOLW,INLET=INLT,ISLAND=IS,ISLANDS=ISS,ISLE=ISLE,JUNCTION=JCT, JUNCTIONS=JCTS,KEY=KY,KEYS=KYS,KNOLL=KNL,KNOLLS=KNLS,LAKE=LK,LAKES=LKS,LAND=LAND,LANDING=LNDG, LANE=LN,LIGHT=LGT,LIGHTS=LGTS,LOAF=LF,LOCK=LCK,LOCKS=LCKS,LODGE=LDG,LOOP=LOOP,MALL=MALL,MANOR=MNR, MANORS=MNRS,MEADOW=MDW,MEADOWS=MDWS,MEWS=MEWS,MILL=ML,MILLS=MLS,MISSION=MSN,MOTORWAY=MTWY, MOUNT=MT,MOUNT=MT,MOUNTAIN=MTN,MOUNTAINS=MTNS,NECK=NCK,ORCHARD=ORCH,OVAL=OVAL,OVERPASS=OPAS, PARK=PARK,PARKWAY=PKWY,PARKWAY=PKWY,PARKWAYS=PKWY,PASS=PASS,PASSAGE=PSGE,PATH=PATH,PIKE=PIKE, PINE=PNE,PINES=PNES,PLACE=PL,PLAIN=PLN,PLAINS=PLNS,PLAZA=PLZ,POINT=PT,POINTS=PTS,PORT=PRT,PORTS=PRTS, PRAIRIE=PR,RADIAL=RADL,RAMP=RAMP,RANCH=RNCH,RAPID=RPD,RAPIDS=RPDS,REST=RST,RIDGE=RDG,RIDGES=RDGS, RIVER=RIV,ROAD=RD,ROADS=RDS,ROUTE=RTE,ROW=ROW,RUE=RUE,RUN=RUN,SHOAL=SHL,SHOALS=SHLS,SHORE=SHR, SHORES=SHRS,SKYWAY=SKWY,SPRING=SPG,SPRINGS=SPGS,SPUR=SPUR,SQUARE=SQ,SQUARES=SQS,STATION=STA, STRAVENUE=STRA,STREAM=STRM,STREET=ST,STREETS=STS,SUMMIT=SMT,TERRACE=TER,THROUGHWAY=TRWY, THRUWAY=TRWY,TRACE=TRCE,TRACK=TRAK,TRAFFICWAY=TRFY,TRAIL=TRL,TUNNEL=TUNL,TURNPIKE=TPKE, UNDERPASS=UPAS,UNION=UN,UNIONS=UNS,VALLEY=VLY,VALLEYS=VLYS,VIADUCT=VIA,VIEW=VW,VIEWS=VWS, VILLAGE=VLG,VILLAGES=VLGS,VILLE=VL,VISTA=VIS,WALK=WALK,WALL=WALL,WAY=WAY,WAYS=WAYS,WELL=WL, WELLS=WLS", "enum": [ "ALY", "ANX", "ARC", "AVE", "BCH", "BG", "BGS", "BLF", "BLFS", "BLVD", "BND", "BR", "BRG", "BRK", "BRKS", "BTM", "BYP", "BYU", "CIR", "CIRS", "CLB", "CLF", "CLFS", "CMN", "COR", "CORS", "CP", "CPE", "CRES", "CRK", "CRSE", "CRST", "CSWY", "CT", "CTR", "CTRS", "CTS", "CURV", "CV", "CVS", "CYN", "DL", "DM", "DR", "DRS", "DV", "EST", "ESTS", "EXPY", "EXT", "EXTS", "FALL", "FLD", "FLDS", "FLS", "FLT", "FLTS", "FRD", "FRDS", "FRG", "FRGS", "FRK", "FRKS", "FRST", "FRY", "FT", "FWY", "GDN", "GDNS", "GLN", "GLNS", "GRN", "GRNS", "GRV", "GRVS", "GTWY", "HBR", "HBRS", "HCR", "HL", "HLS", "HOLW", "HTS", "HVN", "HWY", "INLT", "INST", "IS", "ISLE", "ISS", "JCT", "JCTS", "KNL", "KNLS", "KY", "KYS", "LAND", "LCK", "LCKS", "LDG", "LF", "LGT", "LGTS", "LK", "LKS", "LN", "LNDG", "LOOP", "MALL", "MDW", "MDWS", "MEWS", "ML", "MLS", "MNR", "MNRS", "MSN", "MT", "MTN", "MTNS", "MTWY", "NCK", "OPAS", "ORCH", "OVAL", "PARK", "PASS", "PATH", "PIKE", "PKWY", "PL", "PLN", "PLNS", "PLZ", "PNE", "PNES", "PR", "PRT", "PRTS", "PSGE", "PT", "PTS", "RADL", "RAMP", "RD", "RDG", "RDGS", "RDS", "RIV", "RNCH", "ROW", "RPD", "RPDS", "RST", "RTE", "RUE", "RUN", "SHL", "SHLS", "SHR", "SHRS", "SKWY", "SMT", "SPG", "SPGS", "SPUR", "SQ", "SQS", "ST", "STA", "STRA", "STRM", "STS", "TER", "TPKE", "TRAK", "TRCE", "TRFY", "TRL", "TRLR", "TRWY", "TUNL", "UN", "UNS", "UPAS", "VIA", "VIS", "VL", "VLG", "VLGS", "VLY", "VLYS", "VW", "VWS", "WALK", "WALL", "WAY", "WAYS", "WL", "WLS", "XING", "XRD" ], "type": "string" } } }, "Unit": { "title": "Unit", "type": "object", "required": [ "unitNumber", "unitDesignator" ], "properties": { "unitNumber": { "title": "unitNumber", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 8 }, "unitDesignator": { "title": "unitDesignator", "description": "APARTMENT -APT, BUILDING -BLDG, DEPARTMENT -DEPT, FLOOR -FL, HANGER -HNGR, LOT -LOT, PIER -PIER, ROOM -RM, SLIP -SLIP, SUITE -STE, STOOP -STOP, TRAILER -TRLR, UNIT -UNIT, BASEMENT -BSMT, FRONT -FRNT, OFFICE -OFC, PENTHOUSE -PH, REAR -REAR, LOWER -LOWR, LOBBY -LBBY, SIDE -SIDE, UPPER-UPPR, SPACE-SPC, #-APT Number", "enum": [ "APT", "BLDG", "DEPT", "FL", "HNGR", "LOT", "PIER", "RM", "SLIP", "STE", "SPC", "STOP", "TRLR", "UNIT", "BSMT", "FRNT", "OFC", "PH", "REAR", "LOWR", "LBBY", "SIDE", "UPPR", "#" ], "type": "string" } } }, "PostOfficeBox": { "title": "PostOfficeBox", "description": "Post Office Box Number.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 10 }, "RuralRoute": { "title": "RuralRoute", "type": "object", "required": [ "ruralRouteCenterNumber", "ruralRouteBoxNumber" ], "properties": { "ruralRouteCenterNumber": { "title": "ruralRouteCenterNumber", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 6 }, "ruralRouteBoxNumber": { "title": "ruralRouteBoxNumber", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 10 } } }, "City": { "title": "City", "description": "The City of this address.Mandatory only when Address type = 'Street', 'Military', 'P.O. Box', or 'Rural Route'.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 40 }, "County": { "title": "County", "type": "object", "properties": { "countyName": { "title": "countyName", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 3 }, "countyType": { "title": "countyType", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 1 } } }, "State": { "title": "State", "description": "State abbreviation", "enum": [ "JA", "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AB", "BC", "DR", "MB", "MX", "NB", "NF", "NS", "PE", "PQ", "PR", "SK", "VI", "DF", "NA", "GT", "PU", "YA", "SN", "BA", "AP", "CL", "AA", "BI", "PB", "AG", "BN", "CI", "CP", "CS", "DU", "GJ", "GR", "HD", "HK", "MC", "MR", "NL", "NZ", "OX", "QT", "QR", "SL", "SO", "TA", "TB", "TL", "VE", "YC", "ZA", "ZZ", "AE", "BE", "YT", "AS", "FM", "GM", "MH", "PL", "UM", "VZ", "CE", "CR", "LM", "TE", "FS", "FN", "CN", "GU", "MP", "PW", "NT", "NU", "QC" ], "type": "string" }, "Zip": { "title": "Zip", "type": "object", "required": [ "zipCode" ], "properties": { "zipCodeExtension": { "title": "zipCodeExtension", "description": "Zip code extension used with Zip+4", "type": "string", "pattern": "^((\\d{4}|\\d{4})|((\\d{4}|\\d{4})|\\d{4}))$", "minLength": 4, "maxLength": 4 }, "zipGeoCode": { "title": "zipGeoCode", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "maxLength": 10 }, "zipCode": { "title": "zipCode", "description": "Standard Zip Code", "type": "string", "pattern": "^((\\d{5}|\\d{5})|((\\d{5}|\\d{5})|\\d{5}))$", "minLength": 5, "maxLength": 5 } } }, "Country": { "title": "Country", "description": "International standard (ISO) 2-character country code.", "type": "string", "pattern": "^(([A-Z]{2}|[A-Z]{2})|(([A-Z]{2}|[A-Z]{2})|[A-Z]{2}))$", "minLength": 2, "maxLength": 2 } } }, "secondaryCode": { "title": "secondaryCode", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 0, "maxLength": 6 }, "location": { "title": "location", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "id": { "title": "id", "description": "Unique identifier of a related party", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "dealerCode": { "title": "dealerCode", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$", "minLength": 0, "maxLength": 6 }, "creditCheckAgentLocation": { "title": "creditCheckAgentLocation", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "title": "role", "description": "Role of the related party.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "enum": [ "Customer", "Commission" ], "type": "string" }, "contactName": { "title": "contactName", "type": "object", "required": [ "firstName", "lastName" ], "properties": { "namePrefix": { "title": "namePrefix", "description": "Name prefix or title (e.g. Dr., Mr., Mrs., etc.)", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "firstName": { "title": "firstName", "description": "First Name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "middleName": { "title": "middleName", "description": "Middle name.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "lastName": { "title": "lastName", "description": "Last Name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "nameSuffix": { "title": "nameSuffix", "description": "Name suffix (e.g. Jr. - Junior, Sr. - Senior, etc.)", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "additionalTitle": { "title": "additionalTitle", "description": "A free text field that holds the additional title of the name (e.g. President, Major, General, etc.)", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "billingTelephoneNumber": { "title": "billingTelephoneNumber", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "businessName": { "title": "businessName", "description": "If this individual is the contact of a business, the name of the business. If this is omitted, individual is not a business contact.", "type": "string", "pattern": "^[^<>]{0,200}$" }, "salesRepresentative": { "title": "salesRepresentative", "description": "Objective is to limit the data provided to safeguard parameters.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "RelatedEntity": { "title": "RelatedEntity", "description": "A reference to an entity, where the type of the entity is not known in advance.", "type": "object", "required": [ "id", "role", "@referredType" ], "properties": { "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "role": { "title": "role", "description": "The role of an entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "ApplicableTimePeriod": { "title": "ApplicableTimePeriod", "description": "The period of time for which Capacity or CapacityDemand applies.", "type": "object", "properties": { "dayOfWeek": { "title": "dayOfWeek", "description": "A day or days representing when the schedule is applicable. For example 2, 3 represent Monday and Tuesday.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "rangeInterval": { "title": "rangeInterval", "description": "An indicator that specifies the inclusion or exclusion of the from and to DateTime attributes. \r\nPossible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\".", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "fromToDateTime": { "title": "fromToDateTime", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "validFor": { "title": "validFor", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "type": "object", "properties": { "startDateTime": { "title": "startDateTime", "description": "Start of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" }, "endDateTime": { "title": "endDateTime", "description": "End of the time period, using IETC-RFC-3339 format", "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time" } } }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } }, "CapacityRef": { "title": "CapacityRef", "type": "object", "required": [ "id" ], "properties": { "id": { "title": "id", "description": "unique identifier", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "href": { "title": "href", "description": "Hyperlink reference", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "name": { "title": "name", "description": "Name of the related entity.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@baseType": { "title": "@baseType", "description": "When sub-classing, this defines the super-class", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@schemaLocation": { "title": "@schemaLocation", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@type": { "title": "@type", "description": "When sub-classing, this defines the sub-class Extensible name", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" }, "@referredType": { "title": "@referredType", "description": "The actual type of the target instance when needed for disambiguation.", "type": "string", "pattern": "^[?-~ -%'-;=]{0,200}$" } } } } } }