WSG Model - WEB Outbound (v39.0.0)

Operations

srvQualifByNumber

Description: This operation returns service qualification and resource availability statements for a given request by number.

Input message Output message
srvQualifByNumberRequest srvQualifByNumberResponse

srvQualifByAddress

Description: This operation returns service qualification and resource availability statements for a given request by addres.

Input message Output message
srvQualifByAddressRequest srvQualifByAddressResponse

srvQualifByLocationId

Input message Output message
srvQualifByLocationIdRequest srvQualifByLocationIdResponse

srvQualifByLlid

Description: This operation returns service qualification and resource availability statements for a given request by LLID.

Input message Output message
srvQualifByLlidRequest srvQualifByLlidResponse

srvQualifByStartPoint

Description: This operation returns service qualification and resource availability statements for a given request by Start Point.

Input message Output message
srvQualifByStartPointRequest srvQualifByStartPointResponse

srvQualifBySocket

Description: This operation returns service qualification and resource availability statements for a given request by Socket ID or Coorporation ID.

Input message Output message
srvQualifBySocketRequest srvQualifBySocketResponse

srvQualifByBindingId

Description: This operation returns service qualification and resource availability statements for a given request by bindingId.

Input message Output message
srvQualifByBindingIdRequest srvQualifByBindingIdResponse

getSrvStatus

Description: Obtain status information on a currently installed product or service.

Input message Output message
getSrvStatusRequest getSrvStatusResponse

getTransactionOverview

Description: Create a transaction overview over the various WSG transactions overtime.

Input message Output message
getTransactionOverviewRequest getTransactionOverviewResponse

getOrderDetail

Description: Lookup an order in the WSG DB.

Input message Output message
getOrderDetailRequest getOrderDetailResponse

getInstallationTicketDetail

Description: Lookup an installation ticket in the WSG DB.

Input message Output message
getInstallationTicketDetailRequest getInstallationTicketDetailResponse

getTdmMsgDetail

Description: Lookup a (APV) voice message in the WSG DB.

Input message Output message
getTdmMsgDetailRequest getTdmMsgDetailResponse

getOrderGroupNr

Description: Fetch a new ORDER_GROUP_NR from the WSG DB.

Input message Output message
getOrderGroupNrRequest getOrderGroupNrResponse

getQualifHistory

Description: get the qualificaiton history

Input message Output message
getQualifHistoryRequest getQualifHistoryResponse

createCustomerOrder

Description: Place a new customer order.

Input message Output message
createCustomerOrderRequest createCustomerOrderResponse

cancelPendingOrder

Description: Cancel a pending customer order or order.

Input message Output message
cancelPendingOrderRequest cancelPendingOrderResponse

createInstallationTicket

Description: Create an Installation Ticket

Input message Output message
createInstallationTicketRequest createInstallationTicketResponse

modifyPendingInstallationTicket

Description: Modify a pending Installation Ticket

Input message Output message
modifyPendingInstallationTicketRequest modifyPendingInstallationTicketResponse

cancelPendingInstallationTicket

Description: Cancel a pending Installation Ticket

Input message Output message
cancelPendingInstallationTicketRequest cancelPendingInstallationTicketResponse

getBusinessLines

Description: Get a report for all business lines related to a DDI number

Input message Output message
getBusinessLinesRequest getBusinessLinesResponse

createChangeTicket

Description: create a Change Ticket

Input message Output message
createChangeTicketRequest createChangeTicketResponse

modifyPendingChangeTicket

Description: Modifies a still pending Change Ticket

Input message Output message
modifyPendingChangeTicketRequest modifyPendingChangeTicketResponse

cancelPendingChangeTicket

Description: Cancel a still pending Change Ticket

Input message Output message
cancelPendingChangeTicketRequest cancelPendingChangeTicketResponse

getChangeTicketOverview

Description: gets a list of change Tickets

Input message Output message
getChangeTicketOverviewRequest getChangeTicketOverviewResponse

getChangeTicketDetail

Description: gets all detail of one change ticket

Input message Output message
getChangeTicketDetailRequest getChangeTicketDetailResponse

readPredecessor

Description: Read own predecessor Entity

Input message Output message
readPredecessorEntityRequest readPredecessorEntityResponse

addPredecessorEntity

Input message Output message
addPredecessorEntityRequest addPredecessorEntityResponse

updatePredecessorEntity

Input message Output message
updatePredecessorEntityRequest updatePredecessorEntityResponse

removePredecessorEntity

Input message Output message
removePredecessorEntityRequest removePredecessorEntityResponse

lookUpPredecessors

Description: Search all predecessors for a specific phoneNr or location. You can use the locationId as search attribute in case of you get predecessorAddresses with multiple locationid in the response to have a more precise lookup.

Input message Output message
lookUpPredecessorsRequest lookUpPredecessorsResponse

rescheduleFIOAppointment

Description: Makes a time shift of an existing (booked or reserved) appointment. Retrieves a set of time slots from WFM of which one time slot can be selected as replacement of the existing appointment.

Input message Output message
rescheduleFIOAppointmentRequest rescheduleFIOAppointmentResponse

bookFIOAppointment

Description: Operation to reserve a time slot retrieved in the previous operation (rescheduleFIOAppointment) as an appointment.

Input message Output message
bookFIOAppointmentRequest bookFIOAppointmentResponse




Messages

srvQualifByNumberRequest

Element Type Occ Comment
parameters srvQualifByNumber 1..1

srvQualifByNumberResponse

Element Type Occ Comment
parameters srvQualifByNumberResponse 1..1

srvQualifByAddressRequest

Element Type Occ Comment
parameters srvQualifByAddress 1..1

srvQualifByAddressResponse

Element Type Occ Comment
parameters srvQualifByAddressResponse 1..1

srvQualifByLocationIdRequest

Element Type Occ Comment
parameters srvQualifByLocationId 1..1

srvQualifByLocationIdResponse

Element Type Occ Comment
parameters srvQualifByLocationIdResponse 1..1

srvQualifByLlidRequest

Element Type Occ Comment
parameters srvQualifByLlid 1..1

srvQualifByLlidResponse

Element Type Occ Comment
parameters srvQualifByLlidResponse 1..1

srvQualifByStartPointRequest

Element Type Occ Comment
parameters srvQualifByStartPoint 1..1

srvQualifByStartPointResponse

Element Type Occ Comment
parameters srvQualifByStartPointResponse 1..1

srvQualifBySocketRequest

Element Type Occ Comment
parameters srvQualifBySocket 1..1

srvQualifBySocketResponse

Element Type Occ Comment
parameters srvQualifBySocketResponse 1..1

srvQualifByBindingIdRequest

Element Type Occ Comment
parameters srvQualifByBindingId 1..1

srvQualifByBindingIdResponse

Element Type Occ Comment
parameters srvQualifByBindingIdResponse 1..1

getSrvStatusRequest

Element Type Occ Comment
parameters getSrvStatus 1..1

getSrvStatusResponse

Element Type Occ Comment
parameters getSrvStatusResponse 1..1

getTransactionOverviewRequest

Element Type Occ Comment
parameters getTransactionOverview 1..1

getTransactionOverviewResponse

Element Type Occ Comment
parameters getTransactionOverviewResponse 1..1

getOrderDetailRequest

Element Type Occ Comment
parameters getOrderDetail 1..1

getOrderDetailResponse

Element Type Occ Comment
parameters getOrderDetailResponse 1..1

getInstallationTicketDetailRequest

Element Type Occ Comment
parameters getInstallationTicketDetail 1..1

getInstallationTicketDetailResponse

Element Type Occ Comment
parameters getInstallationTicketDetailResponse 1..1

getTdmMsgDetailRequest

Element Type Occ Comment
parameters getTdmMsgDetail 1..1

getTdmMsgDetailResponse

Element Type Occ Comment
parameters getTdmMsgDetailResponse 1..1

getOrderGroupNrRequest

Element Type Occ Comment
parameters getOrderGroupNr 1..1

getOrderGroupNrResponse

Element Type Occ Comment
parameters getOrderGroupNrResponse 1..1

getQualifHistoryRequest

Element Type Occ Comment
parameters getQualifHistory 1..1

getQualifHistoryResponse

Element Type Occ Comment
parameters getQualifHistoryResponse 1..1

createCustomerOrderRequest

Element Type Occ Comment
parameters createCustomerOrder 1..1

createCustomerOrderResponse

Element Type Occ Comment
parameters createCustomerOrderResponse 1..1

cancelPendingOrderRequest

Element Type Occ Comment
parameters cancelPendingOrder 1..1

cancelPendingOrderResponse

Element Type Occ Comment
parameters cancelPendingOrderResponse 1..1

createInstallationTicketRequest

Element Type Occ Comment
parameters createInstallationTicket 1..1

createInstallationTicketResponse

Element Type Occ Comment
parameters createInstallationTicketResponse 1..1

modifyPendingInstallationTicketRequest

Element Type Occ Comment
parameters modifyPendingInstallationTicket 1..1

modifyPendingInstallationTicketResponse

Element Type Occ Comment
parameters modifyPendingInstallationTicketResponse 1..1

cancelPendingInstallationTicketRequest

Element Type Occ Comment
parameters cancelPendingInstallationTicket 1..1

cancelPendingInstallationTicketResponse

Element Type Occ Comment
parameters cancelPendingInstallationTicketResponse 1..1

getBusinessLinesRequest

Element Type Occ Comment
parameters getBusinessLines 1..1

getBusinessLinesResponse

Element Type Occ Comment
parameters getBusinessLinesResponse 1..1

createChangeTicketRequest

Element Type Occ Comment
parameters createChangeTicket 1..1

createChangeTicketResponse

Element Type Occ Comment
parameters createChangeTicketResponse 1..1

modifyPendingChangeTicketRequest

Element Type Occ Comment
parameters modifyPendingChangeTicket 1..1

modifyPendingChangeTicketResponse

Element Type Occ Comment
parameters modifyPendingChangeTicketResponse 1..1

cancelPendingChangeTicketRequest

Element Type Occ Comment
parameters cancelPendingChangeTicket 1..1

cancelPendingChangeTicketResponse

Element Type Occ Comment
parameters cancelPendingChangeTicketResponse 1..1

getChangeTicketOverviewRequest

Element Type Occ Comment
parameters getChangeTicketOverview 1..1

getChangeTicketOverviewResponse

Element Type Occ Comment
parameters getChangeTicketOverviewResponse 1..1

getChangeTicketDetailRequest

Element Type Occ Comment
parameters getChangeTicketDetailRequestType 1..1

getChangeTicketDetailResponse

Element Type Occ Comment
parameters getChangeTicketDetailResponse 1..1

readPredecessorEntityRequest

Element Type Occ Comment
parameters readPredecessorEntityRequest 1..1

readPredecessorEntityResponse

Element Type Occ Comment
parameters readPredecessorEntityResponse 1..1

addPredecessorEntityRequest

Element Type Occ Comment
parameters addPredecessorEntityRequest 1..1

addPredecessorEntityResponse

Element Type Occ Comment
parameters addPredecessorEntityResponse 1..1

updatePredecessorEntityRequest

Element Type Occ Comment
parameters updatePredecessorEntityRequest 1..1

updatePredecessorEntityResponse

Element Type Occ Comment
parameters updatePredecessorEntityResponse 1..1

removePredecessorEntityRequest

Element Type Occ Comment
parameters removePredecessorEntityRequest 1..1

removePredecessorEntityResponse

Element Type Occ Comment
parameters removePredecessorEntityResponse 1..1

lookUpPredecessorsRequest

Element Type Occ Comment
parameters lookUpPredecessorsRequest 1..1

lookUpPredecessorsResponse

Element Type Occ Comment
parameters lookUpPredecessorsResponse 1..1

rescheduleFIOAppointmentRequest

Element Type Occ Comment
parameters rescheduleFIOAppointmentRequest 1..1

rescheduleFIOAppointmentResponse

Element Type Occ Comment
parameters rescheduleFIOAppointmentResponse 1..1

bookFIOAppointmentRequest

Element Type Occ Comment
parameters bookFIOAppointmentRequest 1..1

bookFIOAppointmentResponse

Element Type Occ Comment
parameters bookFIOAppointmentResponse 1..1




Root elements

srvQualifByNumber

Description: Get information on possible broadband connections to a given destination by DN/VN/NSN.

Element Type Occ Comment
request srvQualifByNumberType 1..1 Get information on possible broadband connections to a given destination by DN/VN/NSN.

srvQualifByNumberResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifByAddress

Description: Get information on possible broadband connections to a given destination by address.

Element Type Occ Comment
request srvQualifByAddressType 1..1 Get information on possible broadband connections to a given destination by address.

srvQualifByAddressResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifByLocationId

Description: Get information on possible broadband connections to a given destination by Location Id.

Element Type Occ Comment
request srvQualifByLocationIdType 1..1 Get information on possible broadband connections to a given destination by location.

srvQualifByLocationIdResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifByLlid

Description: Get information on possible broadband connections to a given destination by LLID.

Element Type Occ Comment
request srvQualifByLlIdType 1..1 Get information on possible broadband connections to a given destination by LLID.

srvQualifByLlidResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifByStartPoint

Description: Get information on possible broadband connections to a given destination by start point.

Element Type Occ Comment
request srvQualifByStartPointType 1..1 Get information on possible broadband connections to a given destination by start point.

srvQualifByStartPointResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifBySocket

Description: Get information on possible broadband connections to a given destination by Socket Id.

Element Type Occ Comment
request srvQualifBySocketType 1..1 Get information on possible broadband connections to a given destination by socket ID (and opt. by PlugNr).

srvQualifBySocketResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifByBindingId

Description: Get information on possible broadband connections to a given destination by bindingId.

Element Type Occ Comment
request srvQualifByBindingIdType 1..1 Get information on possible broadband connections to a given destination by binding ID (accesssId).

srvQualifByBindingIdResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

getSrvStatus

Element Type Occ Comment
request getServiceStatusRequestType 1..1 Purpose: Obtain status information on a currently installed product or service. Directory number to get the state of the service for. In case of PABX with DDI, VN has to be used. In case of broadband type SDSL a NSN has to be used.

getSrvStatusResponse

Element Type Occ Comment
response getServiceStatusAckType 1..1 Acknowledge response for the GET_SERVICE_STATUS command. Provides status information on a currently installed product or service. Service status response

getTransactionOverview

Element Type Occ Comment
request getTransactionOverviewRequestType 1..1 Purpose: List transactions.

getTransactionOverviewResponse

Element Type Occ Comment
response getTransactionOverviewAckType 1..1 This class represents a response message returned by the getTransactionOverview operation. A list of selected transaction records sorted descending by time. This class represents a transaction record documenting any action on a WORK_ORDER, a VOICE_MESSAGE, an ACCESS_TICKET, a WORK_TICKET or an ALARM. Timestamp of last modification. (not null) The name of the user that performed the last modification. (not null) if transType1 = WORK_ORDER, then transType2 = 1001 if transType1 = VOICE_MESSAGE , then transType2 = 1201 if transType1 = VOICE_MESSAGE , then transType2 = 1201 if transType1 = ACCESS_TICKET, then transType2 = empty if transType1 = WORK_TICKET , then transType2 = 4002 The transaction ID. (e.g. if transType1:=WORK_ORDER then transId:=ORDER_ID) (not null) The transaction state. (e.g. if transType1=WORK_ORDER then transType2:=ORDER_STATE hence transType2=2 means 'HOLDING') (not null) The ID of the ISP involved in the transaction. (not null) The name of the ISP involved in the transaction. (not null) The ID of a second ISP involved in the transaction. The name of a second ISP involved in the transaction. The DN/VN/NSN associated to that transaction. (not null) A second DN/VN/NSN associated to that transaction. A transaction response message.

getOrderDetail

Element Type Occ Comment
request getDetailRequestType 1..1 Purpose: Get details of a customer order.

getOrderDetailResponse

Element Type Occ Comment
response getDetailAckType 1..1 Acknowledge response for the GET_DETAIL command.

getInstallationTicketDetail

Element Type Occ Comment
request getInstallationTicketDetailRequestType 1..1 Purpose: Get details of an installation ticket.

getInstallationTicketDetailResponse

Element Type Occ Comment
response getInstallationTicketDetailAckType 1..1 LIST-response for the GET_INSTALLATION_TICKET_DETAIL command. Lists a bunch of matching installation ticket.

getTdmMsgDetail

Element Type Occ Comment
request getTdmMessageDetailRequestType 1..1 Purpose: Get a TDM message with a specific log ID.

getTdmMsgDetailResponse

Element Type Occ Comment
response getTdmMessageDetailAckType 1..1

getOrderGroupNr

Element Type Occ Comment
request getOrderGroupNrRequestType 1..1 Purpose: Obtain a unique number for grouping customer orders. Order group numbers can be used by the ISP to identify related customer orders, e.g. in a LIST_ORDERS command. The resulting order group number will be returned in the ack file.

getOrderGroupNrResponse

Element Type Occ Comment
response customerOrderAckType 1..1 The acknowledge message returned after processing an customer order request.

getQualifHistory

Element Type Occ Comment
request getQualifHistoryRequestType 1..1 Get qualification history from initialy or re- qualifcation

getQualifHistoryResponse

Element Type Occ Comment
response getQualifHistoryAckType 1..1 Get qualification history from initialy or re- qualifcation

createCustomerOrder

Element Type Occ Comment
request customerOrderRequestType 1..1 Purpose: Place a customer order. Data structure for wrapping related detail orders. Restriction: A customer order can contain at most 1 detail order related to a base product (BASIS_CREATE, BASIS_MODIFY, BASIS_DISCONNECT or ISP_CHANGE). The number of service related detail orders is not restricted. Only one basis order may be listed here.

createCustomerOrderResponse

Element Type Occ Comment
response customerOrderAckType 1..1 The acknowledge message returned after processing an customer order request.

cancelPendingOrder

Element Type Occ Comment
request cancelPendingRequestType 1..1 Purpose: Cancel a pending order.

cancelPendingOrderResponse

Element Type Occ Comment
response cancelPendingAckType 1..1 Acknowledge response for the CANCEL_PENDING_ORDER command.

createInstallationTicket

Element Type Occ Comment
request createInstallationTicketRequestType 1..1 Purpose: creates a new installation ticket. WSG order number. This order number identifies the service creation order to which the installation ticket belongs. Required if itIdWsgRef and dnVnNsn is missing [LOV-ID: 0320] Contract Element ID. Required if refOrderNr and itIdWsgRef are missing. Reference to installation ticket (2nd intervention). Required if refOrderNr and dnVnNsn is missing DN, VN or NSN. Required if refOrderNr and itIdWsgRef is missing [LOV-ID: 4003] Onsite support. "None" is not allowed. Required if contrEleId is missing.

createInstallationTicketResponse

Element Type Occ Comment
response createInstallationTicketAckType 1..1 Acknowledge response for the CREATE_INSTALLATION_TICKET command.

modifyPendingInstallationTicket

Element Type Occ Comment
request modifyPendingInstallationTicketRequestType 1..1 Purpose: Modify a pending installation ticket. WSG order number. This order number identifies the service creation order to which the installation ticket belongs. Requested Contract Element ID. Only relevant if the ticket has no reference by itIdWsgRef or refOrderNr. If missing, onsiteSupport is required. [LOV-ID: 0276] Broadband type. Required if contrEleId is specified. DN, VN or NSN. Only relevant if ticket has no reference by refOrderNr and itIdWsgRef. [LOV-ID: 4003] Onsite support. "None" is not allowed. Required if contrEleId is missing.

modifyPendingInstallationTicketResponse

Element Type Occ Comment
response modifyPendingInstallationTicketAckType 1..1 Acknowledge response for the MODIFY_PENDING_INSTALLATION_TICKET command.

cancelPendingInstallationTicket

Element Type Occ Comment
request cancelPendingInstallationTicketRequestType 1..1 Purpose: cancel a pending installation ticket.

cancelPendingInstallationTicketResponse

Element Type Occ Comment
response cancelPendingInstallationTicketAckType 1..1 Acknowledge response for the CANCEL_PENDING_INSTALLATION_TICKET command.

getBusinessLines

Element Type Occ Comment
request getBusinessLinesRequestType 1..1 Purpose: Get a report for all business lines related to a DDI number.

getBusinessLinesResponse

Element Type Occ Comment
response getBusinessLinesAckType 1..1 Acknowledge response for the GET_BUSINESS_LINES command. Provides business lines related to a STNR or DDI number.

createChangeTicket

Element Type Occ Comment
request createChangeTicketRequestType 1..1 Input for the createChangeTicket Operation This contact information is used to send the reminder This contact informations is used to send the 2nd reminder (if not present customerContact1 is used for 2nd reminder)

createChangeTicketResponse

Element Type Occ Comment
response createChangeTicketResponseType 1..1 Output createChangeTicket Operation The change Ticket ID generated by WSG

modifyPendingChangeTicket

Element Type Occ Comment
request modifyPendingChangeTicketRequestType 1..1 Input for the modifyPendingChangeTicket Operation

modifyPendingChangeTicketResponse

Element Type Occ Comment
response modifyPendingChangeTicketResponseType 1..1 Output modifyPendingChangeTicket Operation

cancelPendingChangeTicket

Element Type Occ Comment
request cancelPendingChangeTicketRequestType 1..1 Input cancelPendingChangeTicket Operation

cancelPendingChangeTicketResponse

Element Type Occ Comment
response cancelPendingChangeTicketResponseType 1..1 Output cancelPendingChangeTicket Operation

getChangeTicketOverview

Element Type Occ Comment
request getChangeTicketOverviewRequestType 1..1 Input getChangeTicketOverview Operation

getChangeTicketOverviewResponse

Element Type Occ Comment
response getChangeTicketOverviewResponseType 1..1 Output getChangeTicketOverview Operation

getChangeTicketDetailRequestType

Used by: getChangeTicketDetailRequestType

Element Type Occ Comment
request getChangeTicketDetailRequestType 1..1 Input getChangeTicketDetail Operation

getChangeTicketDetailResponse

Element Type Occ Comment
response getChangeTicketDetailResponseType 1..1 Output getChangeTicketDetail Operation the requested change ticket List of the work log entries all previous data of the change ticket

readPredecessorEntityRequest

Element Type Occ Comment
request readPredecessorEntityRequestType 1..1 Purpose: search predecessor entities

readPredecessorEntityResponse

Element Type Occ Comment
response readPredecessorEntityAckType 1..1 The acknowledge message returned after processing an readPredecessorEntity order request.

addPredecessorEntityRequest

Element Type Occ Comment
request addPredecessorEntityRequestType 1..1 Purpose:Add a predecessor Entity.

addPredecessorEntityResponse

Element Type Occ Comment
response addPredecessorEntityAckType 1..1 The acknowledge message returned after processing an addPredecessorEntity order request.

updatePredecessorEntityRequest

Element Type Occ Comment
request updatePredecessorEntityRequestType 1..1 Purpose:update a predecessor Entity.

updatePredecessorEntityResponse

Element Type Occ Comment
response updatePredecessorEntityAckType 1..1 The acknowledge message returned after processing an updatePredecessorEntity request.

removePredecessorEntityRequest

Element Type Occ Comment
request removePredecessorEntityRequestType 1..1 Purpose:remove a predecessor Entity.

removePredecessorEntityResponse

Element Type Occ Comment
response removePredecessorEntityAckType 1..1 The acknowledge message returned after processing an removePredecessorEntity request.

lookUpPredecessorsRequest

Element Type Occ Comment
request lookUpPredecessorRequestType 1..1 Purpose:search predecessor entrires.

lookUpPredecessorsResponse

Element Type Occ Comment
response lookUpPredecessorsAckType 1..1 The acknowledge message returned after processing an addPredecessorEntity order request.

rescheduleFIOAppointmentRequest

Element Type Occ Comment
request rescheduleFIOAppointmentRequestType 1..1 Request for a time shift of an existing appointment End of the period in which time slots are requested. End of the period in which time slots are requested.

rescheduleFIOAppointmentResponse

Element Type Occ Comment
response rescheduleFIOAppointmentResponseType 1..1 list of time slots as proposal for a new appointment

bookFIOAppointmentRequest

Element Type Occ Comment
request bookFIOAppointmentRequestType 1..1 reserve a time slot Reason for the time shift

bookFIOAppointmentResponse

Element Type Occ Comment
response bookFIOAppointmentResponseType 1..1 gets the appointment ID of the reserved time slot




Types

srvQualifByNumber

Description: Get information on possible broadband connections to a given destination by DN/VN/NSN.

Element Type Occ Comment
request srvQualifByNumberType 1..1 Get information on possible broadband connections to a given destination by DN/VN/NSN.

srvQualifByNumberResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifByAddress

Description: Get information on possible broadband connections to a given destination by address.

Element Type Occ Comment
request srvQualifByAddressType 1..1 Get information on possible broadband connections to a given destination by address.

srvQualifByAddressResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifByLocationId

Description: Get information on possible broadband connections to a given destination by Location Id.

Element Type Occ Comment
request srvQualifByLocationIdType 1..1 Get information on possible broadband connections to a given destination by location.

srvQualifByLocationIdResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifByLlid

Description: Get information on possible broadband connections to a given destination by LLID.

Element Type Occ Comment
request srvQualifByLlIdType 1..1 Get information on possible broadband connections to a given destination by LLID.

srvQualifByLlidResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifByStartPoint

Description: Get information on possible broadband connections to a given destination by start point.

Element Type Occ Comment
request srvQualifByStartPointType 1..1 Get information on possible broadband connections to a given destination by start point.

srvQualifByStartPointResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifBySocket

Description: Get information on possible broadband connections to a given destination by Socket Id.

Element Type Occ Comment
request srvQualifBySocketType 1..1 Get information on possible broadband connections to a given destination by socket ID (and opt. by PlugNr).

srvQualifBySocketResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

srvQualifByBindingId

Description: Get information on possible broadband connections to a given destination by bindingId.

Element Type Occ Comment
request srvQualifByBindingIdType 1..1 Get information on possible broadband connections to a given destination by binding ID (accesssId).

srvQualifByBindingIdResponse

Element Type Occ Comment
response qualifAcknowledgeType 1..1 The acknowledge message returned after processing an qualification request.

getSrvStatus

Element Type Occ Comment
request getServiceStatusRequestType 1..1 Purpose: Obtain status information on a currently installed product or service. Directory number to get the state of the service for. In case of PABX with DDI, VN has to be used. In case of broadband type SDSL a NSN has to be used.

getSrvStatusResponse

Element Type Occ Comment
response getServiceStatusAckType 1..1 Acknowledge response for the GET_SERVICE_STATUS command. Provides status information on a currently installed product or service. Service status response

getTransactionOverview

Element Type Occ Comment
request getTransactionOverviewRequestType 1..1 Purpose: List transactions.

getTransactionOverviewResponse

Element Type Occ Comment
response getTransactionOverviewAckType 1..1 This class represents a response message returned by the getTransactionOverview operation. A list of selected transaction records sorted descending by time. This class represents a transaction record documenting any action on a WORK_ORDER, a VOICE_MESSAGE, an ACCESS_TICKET, a WORK_TICKET or an ALARM. Timestamp of last modification. (not null) The name of the user that performed the last modification. (not null) if transType1 = WORK_ORDER, then transType2 = 1001 if transType1 = VOICE_MESSAGE , then transType2 = 1201 if transType1 = VOICE_MESSAGE , then transType2 = 1201 if transType1 = ACCESS_TICKET, then transType2 = empty if transType1 = WORK_TICKET , then transType2 = 4002 The transaction ID. (e.g. if transType1:=WORK_ORDER then transId:=ORDER_ID) (not null) The transaction state. (e.g. if transType1=WORK_ORDER then transType2:=ORDER_STATE hence transType2=2 means 'HOLDING') (not null) The ID of the ISP involved in the transaction. (not null) The name of the ISP involved in the transaction. (not null) The ID of a second ISP involved in the transaction. The name of a second ISP involved in the transaction. The DN/VN/NSN associated to that transaction. (not null) A second DN/VN/NSN associated to that transaction. A transaction response message.

getOrderDetail

Element Type Occ Comment
request getDetailRequestType 1..1 Purpose: Get details of a customer order.

getOrderDetailResponse

Element Type Occ Comment
response getDetailAckType 1..1 Acknowledge response for the GET_DETAIL command.

getInstallationTicketDetail

Element Type Occ Comment
request getInstallationTicketDetailRequestType 1..1 Purpose: Get details of an installation ticket.

getInstallationTicketDetailResponse

Element Type Occ Comment
response getInstallationTicketDetailAckType 1..1 LIST-response for the GET_INSTALLATION_TICKET_DETAIL command. Lists a bunch of matching installation ticket.

getTdmMsgDetail

Element Type Occ Comment
request getTdmMessageDetailRequestType 1..1 Purpose: Get a TDM message with a specific log ID.

getTdmMsgDetailResponse

Element Type Occ Comment
response getTdmMessageDetailAckType 1..1

getOrderGroupNr

Element Type Occ Comment
request getOrderGroupNrRequestType 1..1 Purpose: Obtain a unique number for grouping customer orders. Order group numbers can be used by the ISP to identify related customer orders, e.g. in a LIST_ORDERS command. The resulting order group number will be returned in the ack file.

getOrderGroupNrResponse

Element Type Occ Comment
response customerOrderAckType 1..1 The acknowledge message returned after processing an customer order request.

getQualifHistory

Element Type Occ Comment
request getQualifHistoryRequestType 1..1 Get qualification history from initialy or re- qualifcation

getQualifHistoryResponse

Element Type Occ Comment
response getQualifHistoryAckType 1..1 Get qualification history from initialy or re- qualifcation

createCustomerOrder

Element Type Occ Comment
request customerOrderRequestType 1..1 Purpose: Place a customer order. Data structure for wrapping related detail orders. Restriction: A customer order can contain at most 1 detail order related to a base product (BASIS_CREATE, BASIS_MODIFY, BASIS_DISCONNECT or ISP_CHANGE). The number of service related detail orders is not restricted. Only one basis order may be listed here.

createCustomerOrderResponse

Element Type Occ Comment
response customerOrderAckType 1..1 The acknowledge message returned after processing an customer order request.

cancelPendingOrder

Element Type Occ Comment
request cancelPendingRequestType 1..1 Purpose: Cancel a pending order.

cancelPendingOrderResponse

Element Type Occ Comment
response cancelPendingAckType 1..1 Acknowledge response for the CANCEL_PENDING_ORDER command.

createInstallationTicket

Element Type Occ Comment
request createInstallationTicketRequestType 1..1 Purpose: creates a new installation ticket. WSG order number. This order number identifies the service creation order to which the installation ticket belongs. Required if itIdWsgRef and dnVnNsn is missing [LOV-ID: 0320] Contract Element ID. Required if refOrderNr and itIdWsgRef are missing. Reference to installation ticket (2nd intervention). Required if refOrderNr and dnVnNsn is missing DN, VN or NSN. Required if refOrderNr and itIdWsgRef is missing [LOV-ID: 4003] Onsite support. "None" is not allowed. Required if contrEleId is missing.

createInstallationTicketResponse

Element Type Occ Comment
response createInstallationTicketAckType 1..1 Acknowledge response for the CREATE_INSTALLATION_TICKET command.

modifyPendingInstallationTicket

Element Type Occ Comment
request modifyPendingInstallationTicketRequestType 1..1 Purpose: Modify a pending installation ticket. WSG order number. This order number identifies the service creation order to which the installation ticket belongs. Requested Contract Element ID. Only relevant if the ticket has no reference by itIdWsgRef or refOrderNr. If missing, onsiteSupport is required. [LOV-ID: 0276] Broadband type. Required if contrEleId is specified. DN, VN or NSN. Only relevant if ticket has no reference by refOrderNr and itIdWsgRef. [LOV-ID: 4003] Onsite support. "None" is not allowed. Required if contrEleId is missing.

modifyPendingInstallationTicketResponse

Element Type Occ Comment
response modifyPendingInstallationTicketAckType 1..1 Acknowledge response for the MODIFY_PENDING_INSTALLATION_TICKET command.

cancelPendingInstallationTicket

Element Type Occ Comment
request cancelPendingInstallationTicketRequestType 1..1 Purpose: cancel a pending installation ticket.

cancelPendingInstallationTicketResponse

Element Type Occ Comment
response cancelPendingInstallationTicketAckType 1..1 Acknowledge response for the CANCEL_PENDING_INSTALLATION_TICKET command.

getBusinessLines

Element Type Occ Comment
request getBusinessLinesRequestType 1..1 Purpose: Get a report for all business lines related to a DDI number.

getBusinessLinesResponse

Element Type Occ Comment
response getBusinessLinesAckType 1..1 Acknowledge response for the GET_BUSINESS_LINES command. Provides business lines related to a STNR or DDI number.

createChangeTicket

Element Type Occ Comment
request createChangeTicketRequestType 1..1 Input for the createChangeTicket Operation This contact information is used to send the reminder This contact informations is used to send the 2nd reminder (if not present customerContact1 is used for 2nd reminder)

createChangeTicketResponse

Element Type Occ Comment
response createChangeTicketResponseType 1..1 Output createChangeTicket Operation The change Ticket ID generated by WSG

modifyPendingChangeTicket

Element Type Occ Comment
request modifyPendingChangeTicketRequestType 1..1 Input for the modifyPendingChangeTicket Operation

modifyPendingChangeTicketResponse

Element Type Occ Comment
response modifyPendingChangeTicketResponseType 1..1 Output modifyPendingChangeTicket Operation

cancelPendingChangeTicket

Element Type Occ Comment
request cancelPendingChangeTicketRequestType 1..1 Input cancelPendingChangeTicket Operation

cancelPendingChangeTicketResponse

Element Type Occ Comment
response cancelPendingChangeTicketResponseType 1..1 Output cancelPendingChangeTicket Operation

getChangeTicketOverview

Element Type Occ Comment
request getChangeTicketOverviewRequestType 1..1 Input getChangeTicketOverview Operation

getChangeTicketOverviewResponse

Element Type Occ Comment
response getChangeTicketOverviewResponseType 1..1 Output getChangeTicketOverview Operation

getChangeTicketDetailRequestType

Used by: getChangeTicketDetailRequestType

Element Type Occ Comment
request getChangeTicketDetailRequestType 1..1 Input getChangeTicketDetail Operation

getChangeTicketDetailResponse

Element Type Occ Comment
response getChangeTicketDetailResponseType 1..1 Output getChangeTicketDetail Operation the requested change ticket List of the work log entries all previous data of the change ticket

readPredecessorEntityRequest

Element Type Occ Comment
request readPredecessorEntityRequestType 1..1 Purpose: search predecessor entities

readPredecessorEntityResponse

Element Type Occ Comment
response readPredecessorEntityAckType 1..1 The acknowledge message returned after processing an readPredecessorEntity order request.

addPredecessorEntityRequest

Element Type Occ Comment
request addPredecessorEntityRequestType 1..1 Purpose:Add a predecessor Entity.

addPredecessorEntityResponse

Element Type Occ Comment
response addPredecessorEntityAckType 1..1 The acknowledge message returned after processing an addPredecessorEntity order request.

updatePredecessorEntityRequest

Element Type Occ Comment
request updatePredecessorEntityRequestType 1..1 Purpose:update a predecessor Entity.

updatePredecessorEntityResponse

Element Type Occ Comment
response updatePredecessorEntityAckType 1..1 The acknowledge message returned after processing an updatePredecessorEntity request.

removePredecessorEntityRequest

Element Type Occ Comment
request removePredecessorEntityRequestType 1..1 Purpose:remove a predecessor Entity.

removePredecessorEntityResponse

Element Type Occ Comment
response removePredecessorEntityAckType 1..1 The acknowledge message returned after processing an removePredecessorEntity request.

lookUpPredecessorsRequest

Element Type Occ Comment
request lookUpPredecessorRequestType 1..1 Purpose:search predecessor entrires.

lookUpPredecessorsResponse

Element Type Occ Comment
response lookUpPredecessorsAckType 1..1 The acknowledge message returned after processing an addPredecessorEntity order request.

rescheduleFIOAppointmentRequest

Element Type Occ Comment
request rescheduleFIOAppointmentRequestType 1..1 Request for a time shift of an existing appointment End of the period in which time slots are requested. End of the period in which time slots are requested.

rescheduleFIOAppointmentResponse

Element Type Occ Comment
response rescheduleFIOAppointmentResponseType 1..1 list of time slots as proposal for a new appointment

bookFIOAppointmentRequest

Element Type Occ Comment
request bookFIOAppointmentRequestType 1..1 reserve a time slot Reason for the time shift

bookFIOAppointmentResponse

Element Type Occ Comment
response bookFIOAppointmentResponseType 1..1 gets the appointment ID of the reserved time slot

srvQualifByBindingIdType

Description: Get information on possible broadband connections to a given destination by binding ID (accesssId).

Used by: srvQualifByBindingId

Extension of: srvQualifType

Element Type Occ Comment
bindingId xs:string (maxLength:15) 1..1 The binding id (e.g. AC1.222.333.444).

srvQualifByNumberType

Description: Get information on possible broadband connections to a given destination by DN/VN/NSN.

Used by: srvQualifByNumber

Extension of: srvQualifType

Element Type Occ Comment
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 1..1 A DN/VN/NSN phone number.

srvQualifByLlIdType

Description: Get information on possible broadband connections to a given destination by LLID.

Used by: srvQualifByLlid

Extension of: srvQualifType

Element Type Occ Comment
llId xs:string (minLength:1, maxLength:13) 1..1 The local loop ID.

srvQualifByAddressType

Description: Get information on possible broadband connections to a given destination by address.

Used by: srvQualifByAddress

Extension of: srvQualifType

Element Type Occ Comment
address subjectAddressEnhancedType 1..1 A complete subject's postal address.

srvQualifByLocationIdType

Description: Get information on possible broadband connections to a given destination by location.

Used by: srvQualifByLocationId

Extension of: srvQualifType

Element Type Occ Comment
locationId xs:int 1..1 A location id (GAIA ID)

srvQualifByStartPointType

Description: Get information on possible broadband connections to a given destination by start point.

Used by: srvQualifByStartPoint

Extension of: srvQualifType

Element Type Occ Comment
startPoint startPointRequestType 1..1 start point request parameters

appointmentType

Description: An appointment

Used by: appointment

Element Type Occ Comment
appointmentId xs:long (totalDigits:10) 1..1 Appointment ID referencing an existing agreement.
appointmentDateTime xs:dateTime 1..1 Date and Time of an Appointment
appointmentEndDateTime xs:dateTime 0..1 End Date and Time of an Appointment

srvQualifType

Description: Get information on possible broadband connections to a given destination. (abstract)

Extended by: srvQualifByBindingIdType, srvQualifByNumberType, srvQualifByLlIdType, srvQualifByAddressType, srvQualifByLocationIdType, srvQualifByStartPointType

Extension of: requestType

Element Type Occ Comment
basisContrEleId xs:int (totalDigits:3) 1..1 [LOV-ID: 0320] A basis contract element ID
contrEleId xs:int (totalDigits:3) 0..n [LOV-ID: 0320] A contract element ID.
bbType xs:int (totalDigits:3) 0..n [LOV-ID: 0276] The BB type.
dnType xs:int (totalDigits:3) 0..n [LOV-ID: 0109] The DN type.
qualifExtRef xs:string (minLength:1, maxLength:80) 0..1 An external reference (assigned by the ISP) for identification of the qualification request.
customerWishDate xs:date 0..1 The customer wish date.
synchWithVoice xs:boolean 0..1 Synchronize with voice.
lineState xs:int (totalDigits:3) 0..1 [LOV-ID: 1052] The copper line state.
newLoop xs:boolean 0..1 Qualify for a new loop.
sfSlaId xs:int (totalDigits:3) 0..1 [LOV-ID: 0282] The service fulfillment SLA ID.
hasOnp xs:boolean 0..1
businessType xs:int (totalDigits:3) 0..1
returnSpeedAtNok xs:boolean 0..1
appointment appointmentType 0..1
customerLocationId xs:int 0..1

orderAckType

Description: The acknowledge message returned after processing an order request.

Used by: customerOrderAckType

Extension of: ackType

Element Type Occ Comment
orderNr xs:string (pattern:[1-9]\d{25}) 0..1 The order ID.

addPredecessorEntityAckType

Description: The acknowledge message returned after processing an addPredecessorEntity order request.

Used by: addPredecessorEntityResponse

Extension of: ackType

Element Type Occ Comment
predecessorEntityId xs:long 0..1 The predecessor entity id.

customerOrderAckType

Description: The acknowledge message returned after processing an customer order request.

Used by: getOrderGroupNrResponse, createCustomerOrderResponse

Extension of: ackType

Element Type Occ Comment
customerOrderNr xs:string (pattern:[1-9]\d{25}) 0..1 The customer order ID.
orderGroupNr xs:long (totalDigits:12) 0..1 The order group ID.
nsn xs:string (pattern:010\d{7}) 0..1 A Net Service Number
preOrderActivationCode xs:string 0..1 The activation code for preOrders
orderItem orderAckType 0..n The acknowledge message returned after processing an order request.

cancelPendingInstallationTicketAckType

Description: Acknowledge response for the CANCEL_PENDING_INSTALLATION_TICKET command.

Used by: cancelPendingInstallationTicketResponse

Extension of: ackType

cancelPendingAckType

Description: Acknowledge response for the CANCEL_PENDING_ORDER command.

Used by: cancelPendingOrderResponse

Extension of: ackType

createInstallationTicketAckType

Description: Acknowledge response for the CREATE_INSTALLATION_TICKET command.

Used by: createInstallationTicketResponse

Extension of: ackType

Element Type Occ Comment
itIdWsg xs:decimal (totalDigits:10) 0..1 Installation ticket id assigned by WSG

getBusinessLinesAckType

Description: Acknowledge response for the GET_BUSINESS_LINES command. Provides business lines related to a STNR or DDI number.

Used by: getBusinessLinesResponse

Extension of: ackType

Element Type Occ Comment
stnr xs:string 0..1 STNR which belongs to the PABX.
vnRecord vnRecord 0..n A business line identity (VN) (= Verrechnungsnummer) record.

getDetailAckType

Description: Acknowledge response for the GET_DETAIL command.

Used by: getOrderDetailResponse

Extension of: ackType

Element Type Occ Comment
customerOrder customerOrderType 0..1 The generic customer order type. A list of orders (E.g. base or service order).

getInstallationTicketDetailAckType

Description: LIST-response for the GET_INSTALLATION_TICKET_DETAIL command. Lists a bunch of matching installation ticket.

Used by: getInstallationTicketDetailResponse

Extension of: ackType

Element Type Occ Comment
ticket ticket 0..1 An installation ticket and its details. [LOV-ID: 4003] Onsite support. "None" is not allowed. Required if contrEleId is missing. WSG order number. This order number identifies the service creation order to which the installation ticket belongs. Required if itIdWsgRef and dnVnNsn is missing DN, VN or NSN. Required if refOrderNr and itIdWsgRef is missing A history entry of the ticket

getOrderGroupNrAckType

Description: Acknowledge response for the GET_ORDER_GROUP_NR command.

Extension of: ackType

Element Type Occ Comment
orderGroupNr xs:long (totalDigits:12) 0..1 The order group ID.

getServiceStatusAckType

Description: Acknowledge response for the GET_SERVICE_STATUS command. Provides status information on a currently installed product or service.

Used by: getSrvStatusResponse

Extension of: ackType

Element Type Occ Comment
status getServiceStatusResponseType 0..1 Service status response

getTransactionOverviewAckType

Description: This class represents a response message returned by the getTransactionOverview operation.

Used by: getTransactionOverviewResponse

Extension of: ackType

Element Type Occ Comment
transaction
Element Type Occ Comment
transDateTime xs:dateTime 1..1 Timestamp of last modification. (not null)
userName xs:string 1..1 The name of the user that performed the last modification. (not null)
transType1 xs:int (totalDigits:3) 1..1 [LOV-ID: 9001] The type of transition. (1 = WORK_ORDER; 2 = VOICE_MESSAGE; 3 = ACCESS_TICKET; 4 = WORK_TICKET; 5 = ALARM)
transType2 xs:int (totalDigits:3) 0..1 if transType1 = WORK_ORDER, then transType2 = 1001 if transType1 = VOICE_MESSAGE , then transType2 = 1201 if transType1 = VOICE_MESSAGE , then transType2 = 1201 if transType1 = ACCESS_TICKET, then transType2 = empty if transType1 = WORK_TICKET , then transType2 = 4002
transId xs:integer 1..1 The transaction ID. (e.g. if transType1:=WORK_ORDER then transId:=ORDER_ID) (not null)
transState xs:int (totalDigits:3) 1..1 The transaction state. (e.g. if transType1=WORK_ORDER then transType2:=ORDER_STATE hence transType2=2 means 'HOLDING') (not null)
ispId1 xs:int (totalDigits:6) 1..1 The ID of the ISP involved in the transaction. (not null)
ispName1 xs:string (minLength:1, maxLength:30) 1..1 The name of the ISP involved in the transaction. (not null)
ispId2 xs:int (totalDigits:6) 0..1 The ID of a second ISP involved in the transaction.
ispName2 xs:string (minLength:1, maxLength:30) 0..1 The name of a second ISP involved in the transaction.
dnVnNsn1 xs:string (pattern:0[1-9]\d{8}) 1..1 The DN/VN/NSN associated to that transaction. (not null)
dnVnNsn2 xs:string (pattern:0[1-9]\d{8}) 0..1 A second DN/VN/NSN associated to that transaction.
response xs:string 0..1 A transaction response message.
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
0..n A list of selected transaction records sorted descending by time. This class represents a transaction record documenting any action on a WORK_ORDER, a VOICE_MESSAGE, an ACCESS_TICKET, a WORK_TICKET or an ALARM. Timestamp of last modification. (not null) The name of the user that performed the last modification. (not null) if transType1 = WORK_ORDER, then transType2 = 1001 if transType1 = VOICE_MESSAGE , then transType2 = 1201 if transType1 = VOICE_MESSAGE , then transType2 = 1201 if transType1 = ACCESS_TICKET, then transType2 = empty if transType1 = WORK_TICKET , then transType2 = 4002 The transaction ID. (e.g. if transType1:=WORK_ORDER then transId:=ORDER_ID) (not null) The transaction state. (e.g. if transType1=WORK_ORDER then transType2:=ORDER_STATE hence transType2=2 means 'HOLDING') (not null) The ID of the ISP involved in the transaction. (not null) The name of the ISP involved in the transaction. (not null) The ID of a second ISP involved in the transaction. The name of a second ISP involved in the transaction. The DN/VN/NSN associated to that transaction. (not null) A second DN/VN/NSN associated to that transaction. A transaction response message.

getTdmMessageDetailAckType

Used by: getTdmMsgDetailResponse

Extension of: ackType

Element Type Occ Comment
tdmMessage tdmMessage 0..1 TDM message (step).

modifyPendingInstallationTicketAckType

Description: Acknowledge response for the MODIFY_PENDING_INSTALLATION_TICKET command.

Used by: modifyPendingInstallationTicketResponse

Extension of: ackType

lookUpPredecessorsAckType

Description: The acknowledge message returned after processing an addPredecessorEntity order request.

Used by: lookUpPredecessorsResponse

Extension of: ackType

Element Type Occ Comment
lookUpPredecessorEntities lookUpPredecessorEntitiesType 1..1 the entities for the lookUpPredecessorsEntities call

readPredecessorEntityAckType

Description: The acknowledge message returned after processing an readPredecessorEntity order request.

Used by: readPredecessorEntityResponse

Extension of: ackType

Element Type Occ Comment
predecessorEntity predecessorEntityType 1..n a predecessor entity

updatePredecessorEntityAckType

Description: The acknowledge message returned after processing an updatePredecessorEntity request.

Used by: updatePredecessorEntityResponse

Extension of: ackType

removePredecessorEntityAckType

Description: The acknowledge message returned after processing an removePredecessorEntity request.

Used by: removePredecessorEntityResponse

Extension of: ackType

rescheduleFIOAppointmentResponseType

Description: list of time slots as proposal for a new appointment

Used by: rescheduleFIOAppointmentResponse

Extension of: ackType

Element Type Occ Comment
fioAppointmentTimeSlots fioAppointmentTimeSlots 0..1 inhouse installation appointments time slots

bookFIOAppointmentResponseType

Description: gets the appointment ID of the reserved time slot

Used by: bookFIOAppointmentResponse

Extension of: ackType

Element Type Occ Comment
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.

qualifAcknowledgeType

Description: The acknowledge message returned after processing an qualification request.

Used by: srvQualifByNumberResponse, srvQualifByAddressResponse, srvQualifByLocationIdResponse, srvQualifByLlidResponse, srvQualifByStartPointResponse, srvQualifBySocketResponse, srvQualifByBindingIdResponse

Extension of: ackType

Element Type Occ Comment
dnStnr xs:string (pattern:0[1-9]\d{8}) 0..1 The DN "Stammnummer".
qualificationResult qualificationResult 0..n Represents a technology (bbType) specific quali response. Is mandatory for the B2B Interface; The LQS Service Availability Qualification Interface does not use this element A list of qualification answers for this particular BB type and service mix combination. LQS Service Availability Qualification Interface: qualifAnswer occurs only once A fiber (bbcs-f) qualification answer

getQualifHistoryAckType

Description: Get qualification history from initialy or re- qualifcation

Used by: getQualifHistoryResponse

Extension of: ackType

Element Type Occ Comment
qualifLogId xs:long (totalDigits:10) 1..1 Qualification Log Id
transDateTime xs:dateTime 1..1 The transition date/time.
orderNr xs:string (pattern:[1-9]\d{25}) 0..1 The order ID.
groupId xs:long (totalDigits:10) 0..1 A group Id of a TDM message.
qualifHistoryRequest qualifHistoryReqDataType 1..1 The qualification request from the history selected time slot
qualifHistoryResponse qualifHistoryResDataType 1..1 The qualification response from the history

createChangeTicketResponseType

Description: Output createChangeTicket Operation

Used by: createChangeTicketResponse

Extension of: ackType

Element Type Occ Comment
changeTicketId xs:decimal (totalDigits:10) 0..1

modifyPendingChangeTicketResponseType

Description: Output modifyPendingChangeTicket Operation

Used by: modifyPendingChangeTicketResponse

Extension of: ackType

Element Type Occ Comment
changeTicketId xs:decimal (totalDigits:10) 0..1 Change Ticket ID assigned by WSG

cancelPendingChangeTicketResponseType

Description: Output cancelPendingChangeTicket Operation

Used by: cancelPendingChangeTicketResponse

Extension of: ackType

getChangeTicketOverviewResponseType

Description: Output getChangeTicketOverview Operation

Used by: getChangeTicketOverviewResponse

Extension of: ackType

Element Type Occ Comment
list
Element Type Occ Comment
changeTicketId xs:decimal (totalDigits:10) 0..1 Change Ticket ID assigned by WSG
changeTicketStatus xs:int (totalDigits:3) 1..1 [LOV-ID: 3021 Change Ticket Status
statusReason xs:int (totalDigits:3) 0..1 [LOV-ID: 3022] A Status Reason set by the backend system
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
exchangeDate xs:date 1..1 designated date for the exchange
exchangeType xs:int (totalDigits:3) 1..1 [LOV-ID: 3020] What must be exchanged (1 = CPE Hardware: 2 = CPE Firmware)
reminderProcess xs:int (totalDigits:3) 1..1 [LOV-ID: 9012] LOV_REMINDER_PROCESS (1 = first reminder at exchange date, second reminder after 5 days ; 2 = first reminder at exchange date, no second reminder)
creationDateTime xs:dateTime 1..1
lastModificationDateTime xs:dateTime 1..1
0..n

getChangeTicketDetailResponseType

Description: Output getChangeTicketDetail Operation

Used by: getChangeTicketDetailResponse

Extension of: ackType

Element Type Occ Comment
changeTicket changeTicketType 0..1
workLog workLogType 0..n List of the work log entries
historyItem changeTicketType 0..n

ackType

Description: The generic acknowledge response type.

Extended by: orderAckType, addPredecessorEntityAckType, customerOrderAckType, cancelPendingInstallationTicketAckType, cancelPendingAckType, createInstallationTicketAckType, getBusinessLinesAckType, getDetailAckType, getInstallationTicketDetailAckType, getOrderGroupNrAckType, getServiceStatusAckType, getTransactionOverviewAckType, getTdmMessageDetailAckType, modifyPendingInstallationTicketAckType, lookUpPredecessorsAckType, readPredecessorEntityAckType, updatePredecessorEntityAckType, removePredecessorEntityAckType, rescheduleFIOAppointmentResponseType, bookFIOAppointmentResponseType, qualifAcknowledgeType, getQualifHistoryAckType, createChangeTicketResponseType, modifyPendingChangeTicketResponseType, cancelPendingChangeTicketResponseType, getChangeTicketOverviewResponseType, getChangeTicketDetailResponseType

Extension of: messageType

Element Type Occ Comment
success xs:boolean 1..1 The result code for the transaction ("true" if request was successful, "false" otherwise).
reason xs:string (pattern:[\dA-Z]{3}) 0..1 A 3-letter error code (aka messageId) where "000" means "ok".
reasonComment xs:string (minLength:1, maxLength:256) 0..1 Some additional textual description for the reason.
operationLogId xs:long 0..1 reference to this operation call. Can be used in clarification tickets

cancelPendingRequestType

Description: Purpose: Cancel a pending order.

Used by: cancelPendingOrder

Extension of: requestType

Element Type Occ Comment
orderNr xs:string (pattern:[1-9]\d{25}) 1..1 The order ID.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.

cancelPendingInstallationTicketRequestType

Description: Purpose: cancel a pending installation ticket.

Used by: cancelPendingInstallationTicket

Extension of: requestType

Element Type Occ Comment
itIdWsg xs:decimal (totalDigits:10) 1..1 Installation ticket id assigned by WSG
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.

createInstallationTicketRequestType

Description: Purpose: creates a new installation ticket.

Used by: createInstallationTicket

Extension of: requestType

Element Type Occ Comment
refOrderNr xs:string (pattern:[1-9]\d{25}) 0..1
contrEleId xs:int (totalDigits:3) 0..1
itIdWsgRef xs:decimal (totalDigits:10) 0..1
bbType xs:int (totalDigits:3) 1..1 [LOV-ID: 0276] The BB type.
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 0..1
custBusinessNr xs:string (maxLength:12) 0..1 The customer business number.
onsiteSupport xs:int (totalDigits:3) 0..1
ispItRef xs:string (minLength:1, maxLength:30) 0..1 An external reference (an ID assigned by the ISP) identifying the installation ticket
endUser endUser 1..1 Contact information on the end user (name, phone numbers, etc)
holdFlag xs:boolean 0..1 If set to true the Installation Ticket is hold until Hardware Delivery Date.
hwDeliveryState xs:int (totalDigits:3) 0..1 [LOV-ID: 4007] Hardware Delivery State.
hwDeliveryDate xs:date 0..1 Hardware Delivery Date.
hwDeliveryLocation xs:string (minLength:1, maxLength:128) 0..1 Hardware delivery location
hwType xs:string (minLength:1, maxLength:128) 0..1 CPE Description
hwExtRefReq xs:string (minLength:1, maxLength:128) 0..1 Additional Information if ONSITE_SUPPORT is not set to 1="None": CPE SAP Order-Number of equipment requested
installDateTimeRange dateTimeRangeType 0..1 Installation frame.
installationType xs:string (minLength:1, maxLength:30) 0..1 Additional installation description.
additionalInstallationReq xs:int (totalDigits:3) 0..n [LOV-ID: 4004] The requested additional installation support.
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.
wosId xs:string (maxLength:17) 0..1 The work order synchronisation ID.

customerOrderRequestType

Description: Purpose: Place a customer order. Data structure for wrapping related detail orders. Restriction: A customer order can contain at most 1 detail order related to a base product (BASIS_CREATE, BASIS_MODIFY, BASIS_DISCONNECT or ISP_CHANGE). The number of service related detail orders is not restricted.

Used by: createCustomerOrder

Extension of: requestType

Element Type Occ Comment
customerOrderNr xs:string (pattern:[1-9]\d{25}) 0..1 The customer order ID.
orderGroupNr xs:long (totalDigits:12) 0..1 The order group ID.
wosId xs:string (maxLength:17) 0..1 The work order synchronisation ID.
qualification qualification 0..1 Required if the base product is not BBCS on TDM (Contract Element 110). The qualification Nr is optional for a base product with Contract Element 110. The qualification Nr must be valid and not expired.
creationType xs:int (totalDigits:3) 1..1 [LOV-ID: 1003] The so-called "kind of creation" of an order.
deliveryNotification xs:boolean 0..1 Notification if x day before planned activation the order isn't ready.
order orderRequestType 1..n
- choice:
Element Type Occ Comment
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 1..1 A DN/VN/NSN phone number.
oto simpleOtoType 1..1 Optical termination outlet.
0..1

getBusinessLinesRequestType

Description: Purpose: Get a report for all business lines related to a DDI number.

Used by: getBusinessLines

Extension of: requestType

Element Type Occ Comment
stnrDdi xs:string (pattern:0[1-9]\d{8}) 1..1 The base number ("Stammnummer") for DDI.

getOrderGroupNrRequestType

Description: Purpose: Obtain a unique number for grouping customer orders. Order group numbers can be used by the ISP to identify related customer orders, e.g. in a LIST_ORDERS command. The resulting order group number will be returned in the ack file.

Used by: getOrderGroupNr

Extension of: requestType

getServiceStatusRequestType

Description: Purpose: Obtain status information on a currently installed product or service.

Used by: getSrvStatus

Extension of: requestType

Element Type Occ Comment
- choice:
Element Type Occ Comment
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 1..1
oto simpleOtoType 1..1 Optical termination outlet.
1..1

modifyPendingInstallationTicketRequestType

Description: Purpose: Modify a pending installation ticket.

Used by: modifyPendingInstallationTicket

Extension of: requestType

Element Type Occ Comment
itIdWsg xs:decimal (totalDigits:10) 1..1 Installation ticket id assigned by WSG
itIdWsgRef xs:decimal (totalDigits:10) 0..1 Reference to installation ticket (2nd intervention)
refOrderNr xs:string (pattern:[1-9]\d{25}) 0..1
contrEleId xs:int (totalDigits:3) 0..1
bbType xs:int (totalDigits:3) 0..1
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 0..1
custBusinessNr xs:string (maxLength:12) 0..1 The customer business number.
onsiteSupport xs:int (totalDigits:3) 0..1
ispItRef xs:string (minLength:1, maxLength:30) 0..1 An external reference (an ID assigned by the ISP) identifying the installation ticket
endUser endUser 1..1 Contact information on the end user (name, phone numbers, etc)
holdFlag xs:boolean 0..1 If set to true the Installation Ticket is hold until Hardware Delivery Date.
hwDeliveryState xs:int (totalDigits:3) 0..1 [LOV-ID: 4007] Hardware Delivery State.
hwDeliveryDate xs:date 0..1 Hardware Delivery Date.
hwDeliveryLocation xs:string (minLength:1, maxLength:128) 0..1 Hardware delivery location
hwType xs:string (minLength:1, maxLength:128) 0..1 CPE Description
hwExtRefReq xs:string (minLength:1, maxLength:128) 0..1 Additional Information if ONSITE_SUPPORT is not set to 1="None": CPE SAP Order-Number of equipment requested
installDateTimeRange dateTimeRangeType 0..1 Installation frame.
installationType xs:string (minLength:1, maxLength:30) 0..1 Additional installation description.
additionalInstallationReq xs:int (totalDigits:3) 0..n [LOV-ID: 4004] The requested additional installation support.
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.
wosId xs:string (maxLength:17) 0..1 The work order synchronisation ID.

getDetailRequestType

Description: Purpose: Get details of a customer order.

Used by: getOrderDetail

Extension of: requestType

Element Type Occ Comment
- choice:
Element Type Occ Comment
orderNr xs:string (pattern:[1-9]\d{25}) 1..1 The order ID.
customerOrderNr xs:string (pattern:[1-9]\d{25}) 1..1 The customer order ID.
1..1

getInstallationTicketDetailRequestType

Description: Purpose: Get details of an installation ticket.

Used by: getInstallationTicketDetail

Extension of: requestType

Element Type Occ Comment
itIdWsg xs:decimal (totalDigits:10) 1..1 Installation ticket id assigned by WSG

getTdmMessageDetailRequestType

Description: Purpose: Get a TDM message with a specific log ID.

Used by: getTdmMsgDetail

Extension of: requestType

Element Type Occ Comment
logId xs:long 1..1 A log ID of a TDM message.

getTransactionOverviewRequestType

Description: Purpose: List transactions.

Used by: getTransactionOverview

Extension of: requestType

Element Type Occ Comment
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 1..1 A DN/VN/NSN phone number.
transType1 xs:int (totalDigits:3) 0..n [LOV-ID: 9001] The type of transition. (1 = WORK_ORDER; 2 = VOICE_MESSAGE; 3 = ACCESS_TICKET; 4 = WORK_TICKET; 5 = ALARM)
- choice:
Element Type Occ Comment
transDateTimeRange dateTimeRangeType 1..1 A range of transition dates/times.
transDateTime xs:dateTime 1..1 The transition date/time.
0..1

addPredecessorEntityRequestType

Description: Purpose:Add a predecessor Entity.

Used by: addPredecessorEntityRequest

Extension of: requestType

Element Type Occ Comment
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 1..1 A DN/VN/NSN phone number.
predecessorName subjectAddressNameType 1..1
phoneNr xs:string (pattern:0[1-9]\d{8}) 0..1 The voice phone number.

lookUpPredecessorRequestType

Description: Purpose:search predecessor entrires.

Used by: lookUpPredecessorsRequest

Extension of: requestType

Element Type Occ Comment
- choice:
Element Type Occ Comment
phoneNr xs:string (pattern:0[1-9]\d{8}) 1..1 The voice phone number.
1..1

readPredecessorEntityRequestType

Description: Purpose: search predecessor entities

Used by: readPredecessorEntityRequest

Extension of: requestType

Element Type Occ Comment
- choice:
Element Type Occ Comment
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 1..1 A DN/VN/NSN phone number.
phoneNr xs:string (pattern:0[1-9]\d{8}) 1..1 The voice phone number.
predecessorEntityId xs:long 1..1 The predecessor entity id.
1..1

removePredecessorEntityRequestType

Description: Purpose:remove a predecessor Entity.

Used by: removePredecessorEntityRequest

Extension of: requestType

Element Type Occ Comment
predecessorEntityId xs:long 1..1 The predecessor entity id.

updatePredecessorEntityRequestType

Description: Purpose:update a predecessor Entity.

Used by: updatePredecessorEntityRequest

Extension of: requestType

Element Type Occ Comment
predecessorEntityId xs:long 1..1 The predecessor entity id.
predecessorName subjectAddressNameType 1..1
phoneNr xs:string (pattern:0[1-9]\d{8}) 0..1 The voice phone number.

srvQualifBySocketType

Description: Get information on possible broadband connections to a given destination by socket ID (and opt. by PlugNr).

Used by: srvQualifBySocket

Extension of: srvQualifFiberType

Element Type Occ Comment
plugNr xs:int (totalDigits:3) 0..1
- choice:
Element Type Occ Comment
socketId xs:string (minLength:13, maxLength:19) 1..1
cooperationId xs:string (maxLength:100) 1..1
1..1

srvQualifFiberType

Description: Get information on possible broadband connections to a given destination. (abstract)

Extended by: srvQualifBySocketType

Extension of: requestType

Element Type Occ Comment
basisContrEleId xs:int (totalDigits:3) 1..1 [LOV-ID: 0320] A basis contract element ID
contrEleId xs:int (totalDigits:3) 0..n [LOV-ID: 0320] A contract element ID.
bbType xs:int (totalDigits:3) 0..n [LOV-ID: 0276] The BB type.
dnType xs:int (totalDigits:3) 0..n [LOV-ID: 0109] The DN type.
businessType xs:int (totalDigits:3) 0..1
qualifExtRef xs:string (minLength:1, maxLength:80) 0..1 An external reference (assigned by the ISP) for identification of the qualification request.
customerWishDate xs:date 0..1 The customer wish date.
sfSlaId xs:int (totalDigits:3) 0..1 [LOV-ID: 0282] The service fulfillment SLA ID.

getQualifHistoryRequestType

Description: Get qualification history from initialy or re- qualifcation

Used by: getQualifHistory

Extension of: requestType

Element Type Occ Comment
orderNr xs:string (pattern:[1-9]\d{25}) 1..1 The order ID.

createChangeTicketRequestType

Description: Input for the createChangeTicket Operation

Used by: createChangeTicket

Extension of: requestType

Element Type Occ Comment
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
exchangeDate xs:date 1..1 designated date for the exchange
exchangeType xs:int (totalDigits:3) 1..1 [LOV-ID: 3020] What must be exchanged (1 = CPE Hardware: 2 = CPE Firmware)
reminderProcess xs:int (totalDigits:3) 1..1 [LOV-ID: 9012] LOV_REMINDER_PROCESS (1 = first reminder at exchange date, second reminder after 5 days ; 2 = first reminder at exchange date, no second reminder)
customerContact1 customerContactType 1..1
customerContact2 customerContactType 0..1
- choice:
Element Type Occ Comment
dnNsn xs:string (pattern:0[1-9]\d{8}) 1..1 A DN/NSN phone number.
dslam dslam 1..1
1..1

modifyPendingChangeTicketRequestType

Description: Input for the modifyPendingChangeTicket Operation

Used by: modifyPendingChangeTicket

Extension of: requestType

Element Type Occ Comment
changeTicketId xs:decimal (totalDigits:10) 1..1 Change Ticket ID assigned by WSG
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
exchangeDate xs:date 1..1 designated date for the exchange
exchangeType xs:int (totalDigits:3) 1..1 [LOV-ID: 3020] What must be exchanged (1 = CPE Hardware: 2 = CPE Firmware)
reminderProcess xs:int (totalDigits:3) 1..1 [LOV-ID: 9012] LOV_REMINDER_PROCESS (1 = first reminder at exchange date, second reminder after 5 days ; 2 = first reminder at exchange date, no second reminder)
customerContact1 customerContactType 1..1 Customer Contact 1
customerContact2 customerContactType 0..1 Customer Contact 2
changeReason xs:string (minLength:1, maxLength:100) 0..1 A reason why the ticket should be changed

cancelPendingChangeTicketRequestType

Description: Input cancelPendingChangeTicket Operation

Used by: cancelPendingChangeTicket

Extension of: requestType

Element Type Occ Comment
changeTicketId xs:decimal (totalDigits:10) 1..1 Change Ticket ID assigned by WSG
cancelReason xs:string (minLength:1, maxLength:100) 1..1 A reason why the ticket should be cancelled

getChangeTicketOverviewRequestType

Description: Input getChangeTicketOverview Operation

Used by: getChangeTicketOverview

Extension of: requestType

Element Type Occ Comment
changeTicketId xs:decimal (totalDigits:10) 0..1 Change Ticket ID assigned by WSG
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
dnNsnRange dnNsnRangeType 0..1
changeTicketStatus xs:int (totalDigits:3) 0..1 [LOV-ID: 3021 Change Ticket Status
ticketCreationDateTimeRange dateTimeRangeType 0..1
lastModificationDateTimeRange dateTimeRangeType 0..1

getChangeTicketDetailRequestType

Description: Input getChangeTicketDetail Operation

Used by: getChangeTicketDetailRequestType

Extension of: requestType

Element Type Occ Comment
changeTicketId xs:decimal (totalDigits:10) 1..1 Change Ticket ID assigned by WSG

requestType

Description: The abstract generic request message type.

Extended by: cancelPendingRequestType, cancelPendingInstallationTicketRequestType, createInstallationTicketRequestType, customerOrderRequestType, getBusinessLinesRequestType, getOrderGroupNrRequestType, getServiceStatusRequestType, modifyPendingInstallationTicketRequestType, getDetailRequestType, getInstallationTicketDetailRequestType, getTdmMessageDetailRequestType, getTransactionOverviewRequestType, addPredecessorEntityRequestType, lookUpPredecessorRequestType, readPredecessorEntityRequestType, removePredecessorEntityRequestType, updatePredecessorEntityRequestType, srvQualifType, srvQualifFiberType, getQualifHistoryRequestType, createChangeTicketRequestType, modifyPendingChangeTicketRequestType, cancelPendingChangeTicketRequestType, getChangeTicketOverviewRequestType, getChangeTicketDetailRequestType

Extension of: messageType

Element Type Occ Comment
ispId xs:int (totalDigits:6) 1..1 An ISP ID.

messageType

Description: The abstract generic message type.

Extended by: ackType, requestType

Attribute Type Use Comment
correlationId xs:string optional A unique ID to correlate request and answer(s) within a (ansynch.) batch process.

qualiResultDetailType

Used by: qualiResultDetail

Element Type Occ Comment
resultCode xs:string (minLength:1, maxLength:4) 1..1 Qualification Result Code
resultComment xs:string (minLength:1, maxLength:256) 1..1 Some additional textual description for the result.

equippedDateHistory

Description: Equipped Date History: list the last 3 changes (if there are some)

Used by: plannedEndPoint

Element Type Occ Comment
sortNr xs:int 1..1 Sort number: 1 (nearest) ... 3 (oldest)
changeDate xs:string (pattern:2[0-9]{3}((-[01][0-9])?)((-[0-3][0-9])?)) 1..1
eventType xs:int (totalDigits:3) 1..1 [LOV-ID: 1324] LOV_EQUIPPED_DATE_EVENT_TYPE 1=TargetDateChange; 2=ValidityClassException
from xs:string (maxLength:10) 1..1 If EventType = 1 - TargetDateChange: Then the format is:2[0-9]{3}((-[01][0-9]))((-[0-3][0-9])); If EventType = 2 - ValidityClassException: Then the format is: string max length 5, example: from: GK4 to: GK98
to xs:string (maxLength:10) 1..1 If EventType = 1 - TargetDateChange: Then the format is:2[0-9]{3}((-[01][0-9]))((-[0-3][0-9])); If EventType = 2 - ValidityClassException: Then the format is: string max length 5, example: from: GK4 to: GK98
changeReasonId xs:int 1..1 Example: [1] Technology change; [2] Port shortage; [3] Missing material; [4] Veto major customer;[5] Veto municipality; [6] Management re-priorisation; [7] Acquisition delay; [8] Construction delay; [9] Changed in the planning phase; [10] Changed in the construction phase; [11] Changed by cooperation partner
changeReasonDescription xs:string (maxLength:100) 1..1

plannedEndPoint

Used by: qualifAnswer

Extension of: endPointBaseType

Element Type Occ Comment
equippedDate xs:string (pattern:2[0-9]{3}(-[01][0-9](-[0-3][0-9])?)?) 1..1 Equipped date and target date are synonyms. Customers are able to order the service at this date.
equippedDateQuality xs:int (totalDigits:2) 1..1 Equipped date quality and quality class are synonyms.
equippedDateComment xs:string 1..1 The equippedDate embedded in a comment string
equippedDateHistory equippedDateHistory 0..n Equipped Date History: list the last 3 changes (if there are some) Sort number: 1 (nearest) ... 3 (oldest) [LOV-ID: 1324] LOV_EQUIPPED_DATE_EVENT_TYPE 1=TargetDateChange; 2=ValidityClassException If EventType = 1 - TargetDateChange: Then the format is:2[0-9]{3}((-[01][0-9]))((-[0-3][0-9])); If EventType = 2 - ValidityClassException: Then the format is: string max length 5, example: from: GK4 to: GK98 If EventType = 1 - TargetDateChange: Then the format is:2[0-9]{3}((-[01][0-9]))((-[0-3][0-9])); If EventType = 2 - ValidityClassException: Then the format is: string max length 5, example: from: GK4 to: GK98 Example: [1] Technology change; [2] Port shortage; [3] Missing material; [4] Veto major customer;[5] Veto municipality; [6] Management re-priorisation; [7] Acquisition delay; [8] Construction delay; [9] Changed in the planning phase; [10] Changed in the construction phase; [11] Changed by cooperation partner
plannedSpeed duplexSpeedType 1..1 The planned bitrate (up/down).
extensionCategory xs:int (totalDigits:3) 1..1 [LOV-ID: 9023] LOV_EXTENSION_CATEGORY: Ausbau Kategorie: 1 = PUS Neubau; 2 = FTTS/B Neubau; 3 = Vectoring Ausbau/Aktivierung

duplexSpeedType

Description: A upstream/downstream speed pair.

Used by: speedProfileType, effectiveSpeed, plannedSpeed

Element Type Occ Comment
up xs:int 1..1 Upload speed in kbit/sec.
down xs:int 1..1 Download speed in kbit/sec.

speedProfileType

Description: A speed profile type.

Used by: fiberQualifProfileType, plugType, qualifProfileType, serviceOrderHistoryType, serviceOrderType, serviceStatusServiceType, tdmMessageBaseType, accessSpeed, speedProfile, qualifAnswer

Element Type Occ Comment
speedProfileNr xs:int (totalDigits:3) 1..1 [LOV-ID: 1010] A speed profile number.
description xs:string (minLength:1, maxLength:60) 0..1
max duplexSpeedType 0..1 A upstream/downstream speed pair. Upload speed in kbit/sec. Download speed in kbit/sec.
min duplexSpeedType 0..1 A upstream/downstream speed pair. Upload speed in kbit/sec. Download speed in kbit/sec.
technologyType xs:int (totalDigits:3) 0..1 [LOV-ID: 9025] LOV_TECHNOLOGY_TYPE: Which standard was uesd for bitrate calculation: 1 = VDSL2; 2 = VDSL Vectoring; 3 = G.FAST

subjectAddressEnhancedType

Description: A complete subject's postal address.

Used by: lookUpPredecessorRequestType, srvQualifByAddressType

Extension of: subjectAddressType

Element Type Occ Comment
subjectAddressName subjectAddressNameType 0..1 Person or company name.

contactAddressType

Description: Contact Information

Used by: inhouseInstallationInfoType, inhouseInstallationRequestType

Extension of: subjectAddressType

Element Type Occ Comment
firstName xs:string (minLength:1, maxLength:30) 0..1 A subject's first name.
lastName xs:string (minLength:1, maxLength:30) 0..1 A subject's last name.
language xs:string 0..1 ISO 639-1 (Codes for the representation of names of languages) (de = german; fr = french; it = italian)
eMail xs:string (minLength:5, maxLength:100) 0..1 An E-Mail address (a.b@x.com)
phone xs:string (pattern:(\+)?([0-9]){7,15}) 0..1 phone number
phone2 xs:string (pattern:(\+)?([0-9]){7,15}) 0..1 Second phone number
comment xs:string (minLength:1, maxLength:256) 0..1 a comment to this address Informations

subjectAddressType

Description: A subject's postal address.

Used by: predecessorAddress, qualifHistoryReqDataType

Extended by: subjectAddressEnhancedType, contactAddressType

Extension of: addressType

addressType

Description: An (geographical) address entity.

Used by: baseProductOrderType, qualifAnswer, fiberQualifAnswer

Extended by: subjectAddressType

Element Type Occ Comment
street xs:string (minLength:1, maxLength:30) 0..1 The street name of an address.
houseNr xs:string (minLength:1, maxLength:12) 0..1 The house number of an address.
building xs:string (minLength:1, maxLength:30) 0..1 The building infomation of an address.
zip xs:int (minInclusive:1000, maxInclusive:999999) 0..1 The zip of an address.
city xs:string (minLength:1, maxLength:25) 0..1 The city of an address.
additionalCity xs:string (minLength:1, maxLength:25) 0..1 The additional city information of an address.

qualifProfileType

Description: Represents a speed profile making up a part of a qualification result.

Used by: qualifAnswer

Element Type Occ Comment
qualifIndex xs:long (totalDigits:10) 0..1 The index identifying a profile within a qualification response.
nrOfWires xs:int (totalDigits:2) 0..1 The number of wires (only copper).
usedAccessSpeed speedProfileType 0..1 A speed profile type.
serviceSpeed speedProfileType 1..1 A speed profile type.
effectiveSpeed duplexSpeedType 0..1 The effective speed/virtual profile.

llDateType

Description: Local Loop Date

Used by: qualifAnswer

Element Type Occ Comment
activationDate xs:date 0..1
disconnectionDate xs:date 0..1

qualifAnswer

Description: Represents a (per start point) answerblock as part of the qualification result.

Used by: qualificationResult

Element Type Occ Comment
qualiResultState xs:string (Enumeration: ok, ok_stao, planned, nok) 0..1 State of the Qualification Result.
qualiResultDetail qualiResultDetailType 0..n
endPoint endPointType 0..1 An end point (consisting of a DN office and a BB device location) and port information.
plannedEndPoint plannedEndPoint 0..1 A planned end point (plannedEndpoint wird abgefuellt, wenn bekannt ist, dass der Startpunkt in Zukunft von einem neuen Breitbandziel bedient wird.).
cpeInfo cpeInfo 0..1 Information about the CPE.
maxAccessSpeed speedProfileType 0..1 The speed profile identifying the maximum possible access speed.
averageFlag xs:int (totalDigits:3) 0..1 [LOV-ID: 1050] The average flag marking the average answer within a multi-answer qualif response (0=The non-average qualif answer; 1=The average qualif answer (strict address qualif); 2=The average qualif answer (fuzzy address qualif)).
nrOfWires xs:int (totalDigits:2) 0..1 The number of wires (only copper).
billingZone xs:int (totalDigits:3) 0..1 [LOV-ID: 1503] The billing zone.
fulfillmentTimeSlot fulfillmentTimeSlot 0..n A list of fulfillment time slots
startPoint startPointType 0..1
address addressType 0..1 The address associated with this start point.
resourceAvailability
Element Type Occ Comment
available xs:boolean 1..1 true if the resource is available, else false.
resourceType xs:int (totalDigits:3) 1..1 [LOV-ID: 1055] Resource Type (1 = Port; 2 = Copper, 3 = WARP Port).
upgradePlanDateTime xs:dateTime 0..1 The planned upgrade time if resource unavailable.
0..n A list of resource availability statements. true if the resource is available, else false. The planned upgrade time if resource unavailable.
qualifProfile qualifProfileType 0..n Represents a speed profile making up a part of a qualification result.
currentDnType xs:int (totalDigits:3) 0..1 [LOV-ID: 0109] The current DnType
currentAccessSpeed speedProfileType 0..1 The current access speed profile
llId xs:string (minLength:1, maxLength:13) 0..1 The local loop ID.
llDate llDateType 0..1 Local Loop Date
jumperAction xs:boolean 0..1 Ueberfuehrungsrelevant (true/false).
bbrRecommendation xs:int (totalDigits:3) 0..1 [LOV-ID: 1051] Broadband ready recommendation of Field Service (FS) Installation: 0 = na (it is not possible to give a self install recommendation); 1 = BBR necessary (no self install recommended); 2 = no BBR necessary (selfinstall possible); 3 = no BBR necessary (selfinstall possible); 4 = BBR necessary (no self install recommended); 5 = BBR Socket installed;
potentialAvailable xs:int (totalDigits:1) 0..1 [LOV-ID 1054] Potential available that after a BBR an upgrooming could be started - so the access speed will may be higher and the quality will not be worse.
reasonOfPotential reasonOfPotential 0..1 Reason of Potential - why is the Current Access Speed lower then the maximum
technologyType xs:int (totalDigits:3) 0..1 [LOV-ID: 9025] LOV_TECHNOLOGY_TYPE: Which standard was uesd for bitrate calculation: 1 = VDSL2; 2 = VDSL Vectoring; 3 = G.FAST
lineState xs:int (totalDigits:3) 0..1 [LOV-ID: 1052] The copper line state.
vectorized xs:boolean 0..1 true if line is currently vectorized
siteDevelopment siteDevelopment 0..1 site development information, quantiy of basic connectivities and utilized units
swisscomReady xs:boolean 0..1 Flag indicating if the line is currently swisscom ready, means a All-IP access is provisioned
psdClass xs:int (totalDigits:3) 0..1 [LOV-ID: 1061] LOV_BB_PSD_CLASS
interleaveMode xs:int (totalDigits:3) 0..1 [LOV-ID: 1008] LOV_INTERLEAVE_MODE

availableTechnologyType

Used by: endPointType

Element Type Occ Comment
technologyType xs:int (totalDigits:3) 1..n [LOV-ID: 9025] LOV_TECHNOLOGY_TYPE: Which standard was uesd for bitrate calculation: 1 = VDSL2; 2 = VDSL Vectoring; 3 = G.FAST

bbPortInfoType

Used by: bbPortInfo

Element Type Occ Comment
dslamName xs:string (maxLength:30) 0..1 name of the DSLAM (e.g.: ipc-aar730-s-vd-05)
dslamType xs:int (totalDigits:3) 0..1 [LOV-ID: 1064]: DSLAM Type.
bbPortNr xs:string (minLength:1, maxLength:15) 0..4 Splitter Port
bbAdslEmulated xs:int (totalDigits:3) 0..1 [LOV-ID: 0401]: ADSL emulated flag.
bbPortLineType xs:int (totalDigits:3) 0..1 [LOV-ID: 1353] bb Port Line Type
vendor xs:string (maxLength:32) 0..1 The vendor of the DSLAM

endPointType

Description: An end point (consisting of a DN office and a BB device location) and port information.

Used by: endPoint

Extension of: endPointBaseType

Element Type Occ Comment
availableTechnologyType availableTechnologyType 0..1 An (geographical) address entity.
bbPortInfo bbPortInfoType 0..1 Information about the Port in the loop.

endPointBaseType

Description: An end point (consisting of a DN office and a BB device location).

Used by: fiberQualifAnswer

Extended by: endPointType, plannedEndPoint

Element Type Occ Comment
taxRegion xs:int (totalDigits:3) 0..1 [LOV-ID: 1504] The tax region part of a start- or end-point (e.g. "62").
accessNet xs:string (minLength:1, maxLength:5) 0..1 The access net part of a start- or end-point (e.g. "ALL").
site xs:string (maxLength:4) 0..1 Site of the Broad Band Device Location.
siteCategory xs:int (totalDigits:3) 0..1 [LOV-ID: 9008] The site categorization.
bbDeviceLocation xs:string (minLength:1, maxLength:20) 0..1 The broad band device location. (e.g. "AES")

availability

Used by: fiberQualifAnswer

Element Type Occ Comment
availabilityDate xs:date 0..1 Availability date and target date are synonyms. Customers are able to order the service at this date.
validityClass xs:string (minLength:1, maxLength:12) 1..1 Validity class and quality class are synonyms. Possible values are: "GK1", "GK2", "GK3", "GK4", "GK5", "GK98", "GK99"
reason xs:string (minLength:1, maxLength:256) 0..1

events

Used by: fiberQualifAnswer

Element Type Occ Comment
event
Element Type Occ Comment
eventType xs:string (maxLength:32) 1..1 possible values are: "1 - TargetDateChange", "2 - ValidityClassException", "99 - Reserve"
sequenceNumber xs:int 1..1
eventTimeStamp xs:dateTime 1..1
from xs:string (maxLength:10) 0..1
to xs:string (maxLength:10) 0..1
eventReason xs:string (maxLength:100) 0..1
1..n possible values are: "1 - TargetDateChange", "2 - ValidityClassException", "99 - Reserve"

fiberQualifAnswer

Description: Represents a fiber qualification answer.

Used by: qualificationResult

Element Type Occ Comment
qualiResultState xs:string (Enumeration: ok, ok_stao, planned, nok) 1..1 State of the Qualification Result.
qualiResultDetail qualiResultDetailType 0..n
endPoint endPointBaseType 0..1 An end point (consisting of a DN office and a BB device location).
address addressType 0..1 The address associated with this start point.
locationId xs:int 0..1
socket socketType 0..n List of sockets
fioAppointmentTimeSlots fioAppointmentTimeSlots 0..1 inhouse installation appointments time slots
bep
Element Type Occ Comment
locationId xs:int 1..1 A location id.
bepState xs:int (totalDigits:3) 0..1 The BEP State (connected, available, planned or not connected)
availability availability 0..1 Validity class and quality class are synonyms. Possible values are: "GK1", "GK2", "GK3", "GK4", "GK5", "GK98", "GK99"
inHouseAllowed xs:boolean 1..1 In house installation allowed
firstInHouse xs:boolean 1..1
maxAccessSpeedKbps xs:int 1..n
initialMountingShaftCapacity xs:string (maxLength:32) 1..1 possible values are: "available", "not available", "not checked"
bepBuilder xs:string (maxLength:8) 0..1 possible values are: "SCS", "KOPA"
siteCategory xs:string (maxLength:32) 0..1 possible values are: "standard", "remote_fan_fibre_spot"
events events 0..1 possible values are: "1 - TargetDateChange", "2 - ValidityClassException", "99 - Reserve"
address addressType 0..1 An (geographical) address entity.
0..n Building Entry Point The BEP State (connected, available, planned or not connected) possible values are: "available", "not available", "not checked" possible values are: "SCS", "KOPA" possible values are: "standard", "remote_fan_fibre_spot"

qualificationResult

Description: Represents a technology (bbType) specific quali response.

Used by: qualifAcknowledgeType

Element Type Occ Comment
contrEleId xs:int (totalDigits:3) 0..n [LOV-ID: 0320] A contract element ID.
bbType xs:int (totalDigits:3) 0..1 [LOV-ID: 0276] The BB type.
dnType xs:int (totalDigits:3) 0..1 [LOV-ID: 0109] The DN type.
qualifNr xs:long (totalDigits:10) 0..1
lineState xs:int (totalDigits:3) 0..1 [LOV-ID: 1052] The copper line state.
- choice:
Element Type Occ Comment
qualifAnswer qualifAnswer 1..n
fiberQualifAnswer fiberQualifAnswer 1..n
1..1

subjectAddressNameType

Description: Person or company name.

Used by: predecessorInfoType, subjectAddressEnhancedType, predecessorName

startPointRequestType

Description: start point request parameters

Used by: srvQualifByStartPointType, qualifHistoryReqDataType

Element Type Occ Comment
taxRegion xs:int (totalDigits:3) 1..1 [LOV-ID: 1504] The tax region part of a start- or end-point (e.g. "62").
accessNet xs:string (minLength:1, maxLength:5) 1..1 The access net part of a start- or end-point (e.g. "ALL").
unitType xs:int (totalDigits:3) 1..1 The type of unit for UP.
unitNumber xs:int (totalDigits:6) 1..1 The number of unit for UP.
sse xs:int (totalDigits:2) 1..1 The 'sse' for UP.
contactType xs:int (totalDigits:3) 0..1 [LOV-ID: 0115] The type of contact for UP.
contactNr xs:int (totalDigits:6) 0..1 The contact number for UP.

simpleOtoType

Description: Socket (Fiber)

Used by: oto

Element Type Occ Comment
- choice:
Element Type Occ Comment
socketId xs:string (minLength:13, maxLength:19) 1..1 A socket id (e.g. A.123.456.789).
cooperationId xs:string (maxLength:100) 1..1
1..1
plug xs:int (totalDigits:3) 1..1 the plug

sla

Used by: createType, modifyPendingBaseOrdType, modifyType, ispChangeType, addType, changeType, modifyPendingSrvOrdType, baseOrderType, getServiceStatusResponseType, orderHistoryType, serviceStatusServiceType, tdmMessageBaseType

Element Type Occ Comment
sfSlaId xs:int (totalDigits:3) 0..1 [LOV-ID: 0282] The service fulfillment SLA ID.
saSlaId xs:int (totalDigits:3) 0..1 [LOV-ID: 0283] The service level assurance id

startPointType

Description: The start point associated with this qualification result. (example: "79,TET,UP,2,1")

Used by: startPoint

Element Type Occ Comment
taxRegion xs:int (totalDigits:3) 1..1 [LOV-ID: 1504] The tax region part of a start- or end-point (e.g. "62").
accessNet xs:string (minLength:1, maxLength:5) 1..1 The access net part of a start- or end-point (e.g. "ALL").
unitType xs:int (totalDigits:3) 1..1 The type of unit for UP.
unitNumber xs:int (totalDigits:6) 1..1 The number of unit for UP.
sse xs:int (totalDigits:2) 1..1 The 'sse' for UP.
contactType xs:int (totalDigits:3) 0..1 [LOV-ID: 0115] The type of contact for UP.
contactNr xs:int (totalDigits:6) 0..4 The contact number for UP.
upPreparation xs:int (totalDigits:3) 0..1 [LOV-ID: 1070] Copper minimal development (1 = Normal, 2 =Copper minimal development, 3...5 = Reserve)

potential

Description: Description of Potential

Used by: reasonOfPotential

Element Type Occ Comment
potentialCode xs:int (minInclusive:-9999, maxInclusive:9999) 1..1 Potential Code negative value: reason why the maximum speed is lower then the current access profile. -1000: Pending downgrooming without service impact -1001: Pending downgrooming with service impact -1100: Pending devloc change (lengthing order) -1200: The profile is set manually -1300: -1400: The access is unstable -1501: ICA problem - impact on stability: BridgeTap -1502: ICA problem - impact on stability: Degraded Contact -1503: ICA problem - impact on speed: Missing Splitter -1504: ICA problem - impact on stability: Missing Splitter on alarm system (Business Decision) -1505: ICA problem - impact on stability: External Interference detected -1506: ICA problem - impact on stability: Intermittent contact -1507: ICA problem - impact on stability: Loop unbalanced -1508: ICA problem - impact on stability: Untwisted in-house wiring -1509: ICA problem - impact on stability: Time varying noise (crosstalk and RFI) -1510: ICA problem - impact on stability: CPE interoperability problem -1511: ICA problem - impact on stability: Black-listed CPE -1517: ICA problem - impact on stability: Abnormal crosstalk -1518: ICA problem - impact on stability: Defect switched power supply -1519: ICA problem - impact on speed: BridgeTap on overhead line -1600: Stability reached with downgrade positive value: reason why the maximum speed is higher then the current acccess profile 1000: outstanding upgrooming 1100: pending devloc change (short order) 1200: the profile is set manually 1300: Old CPE hardware 1301: CPE hardware doesnt support Vectoring. 1302: CPE firmware doesnt support Vectoring
potentialDescription xs:string (minLength:1, maxLength:256) 1..1 Potential Description

reasonOfPotential

Description: Reason of Potential - why is the Current Access Speed lower then the maximum

Used by: customerOrderType, getServiceStatusResponseType, qualifAnswer

Element Type Occ Comment
potential potential 1..n Description of Potential Potential Code negative value: reason why the maximum speed is lower then the current access profile. -1000: Pending downgrooming without service impact -1001: Pending downgrooming with service impact -1100: Pending devloc change (lengthing order) -1200: The profile is set manually -1300: -1400: The access is unstable -1501: ICA problem - impact on stability: BridgeTap -1502: ICA problem - impact on stability: Degraded Contact -1503: ICA problem - impact on speed: Missing Splitter -1504: ICA problem - impact on stability: Missing Splitter on alarm system (Business Decision) -1505: ICA problem - impact on stability: External Interference detected -1506: ICA problem - impact on stability: Intermittent contact -1507: ICA problem - impact on stability: Loop unbalanced -1508: ICA problem - impact on stability: Untwisted in-house wiring -1509: ICA problem - impact on stability: Time varying noise (crosstalk and RFI) -1510: ICA problem - impact on stability: CPE interoperability problem -1511: ICA problem - impact on stability: Black-listed CPE -1517: ICA problem - impact on stability: Abnormal crosstalk -1518: ICA problem - impact on stability: Defect switched power supply -1519: ICA problem - impact on speed: BridgeTap on overhead line -1600: Stability reached with downgrade positive value: reason why the maximum speed is higher then the current acccess profile 1000: outstanding upgrooming 1100: pending devloc change (short order) 1200: the profile is set manually 1300: Old CPE hardware 1301: CPE hardware doesnt support Vectoring. 1302: CPE firmware doesnt support Vectoring Potential Code negative value: reason why the maximum speed is lower then the current access profile. -1000: Pending downgrooming without service impact -1001: Pending downgrooming with service impact -1100: Pending devloc change (lengthing order) -1200: The profile is set manually -1300: -1400: The access is unstable -1501: ICA problem - impact on stability: BridgeTap -1502: ICA problem - impact on stability: Degraded Contact -1503: ICA problem - impact on speed: Missing Splitter -1504: ICA problem - impact on stability: Missing Splitter on alarm system (Business Decision) -1505: ICA problem - impact on stability: External Interference detected -1506: ICA problem - impact on stability: Intermittent contact -1507: ICA problem - impact on stability: Loop unbalanced -1508: ICA problem - impact on stability: Untwisted in-house wiring -1509: ICA problem - impact on stability: Time varying noise (crosstalk and RFI) -1510: ICA problem - impact on stability: CPE interoperability problem -1511: ICA problem - impact on stability: Black-listed CPE -1517: ICA problem - impact on stability: Abnormal crosstalk -1518: ICA problem - impact on stability: Defect switched power supply -1519: ICA problem - impact on speed: BridgeTap on overhead line -1600: Stability reached with downgrade positive value: reason why the maximum speed is higher then the current acccess profile 1000: outstanding upgrooming 1100: pending devloc change (short order) 1200: the profile is set manually 1300: Old CPE hardware 1301: CPE hardware doesnt support Vectoring. 1302: CPE firmware doesnt support Vectoring Potential Description

cableBox

Description: The cable box (aka. "Ueberfuehrungspunkt", "UP").

Used by: baseProductOrderType, getServiceStatusResponseType, tdmMessageBaseType, vnRecord

Element Type Occ Comment
boardNr xs:int (totalDigits:6) 1..1 UP Board Nr.
switchingPlaceNr xs:int (totalDigits:6) 1..1 UP Switching Place Nr.
contactType xs:int (totalDigits:3) 1..1 [LOV-ID: 0115] The type of contact for UP.
contactNr xs:int (totalDigits:6) 1..4 The contact number for UP.
coordinateX xs:int (totalDigits:6) 0..1 X coordinate of UP.
coordinateY xs:int (totalDigits:6) 0..1 Y coordinate of UP.

dslamTypeAllowed

Description: DSLAM Type(s) which are supported from the cpe - only current Technolgoie is in focus

Used by: cpeInfo

Element Type Occ Comment
technology xs:int (totalDigits:3) 1..1
dslamType xs:int (totalDigits:3) 0..n [LOV-ID: 1064]: DSLAM Type.

capability

Used by: cpeInfo

Element Type Occ Comment
technologyType xs:int (totalDigits:3) 1..1 [LOV-ID: 9025] LOV_TECHNOLOGY_TYPE (1 = VDSL; 2 = VDSL vectoring; 3 = G.FAST)
capabilityOverall xs:int (totalDigits:3) 1..1 [LOV-ID: 9009] LOV_CPE_CAPABILITY_OVERALL (former LOV_VECTORING_CAPABILITY) (1 = Capable; 2 = Friendly; 3 = Forced Friendly; 4 = Disturber....)
capabilityHardware xs:int (totalDigits:3) 1..1 [LOV-ID: 1350] LOV_CPE_CAPABILITY Does this CPE Hardware or Firmware support the declared TechnologyType? (0 = no;1 = yes; 2 = yes, but SFP needed)
capabilityFirmware xs:int (totalDigits:3) 1..1 [LOV-ID: 1350] LOV_CPE_CAPABILITY Does this CPE Hardware or Firmware support the declared TechnologyType? (0 = no;1 = yes; 2 = yes, but SFP needed)

cpeInfo

Description: Information about the CPE.

Used by: customerOrderType, getServiceStatusResponseType, qualifHistoryResDataType, qualifAnswer

Element Type Occ Comment
cpeName xs:string (maxLength:100) 1..1 CPE (Customer Modem) Name
dslamTypeAllowed dslamTypeAllowed 0..n DSLAM Type(s) which are supported from the cpe - only current Technolgoie is in focus
capability capability 0..n CPE Capability, used in case of VDSL2 qualification to shows the TechnologyType (VDSL2 Legacy, Vectoring, g.fast) capability. [LOV-ID: 9025] LOV_TECHNOLOGY_TYPE (1 = VDSL; 2 = VDSL vectoring; 3 = G.FAST) [LOV-ID: 9009] LOV_CPE_CAPABILITY_OVERALL (former LOV_VECTORING_CAPABILITY) (1 = Capable; 2 = Friendly; 3 = Forced Friendly; 4 = Disturber....) [LOV-ID: 1350] LOV_CPE_CAPABILITY Does this CPE Hardware or Firmware support the declared TechnologyType? (0 = no;1 = yes; 2 = yes, but SFP needed) [LOV-ID: 1350] LOV_CPE_CAPABILITY Does this CPE Hardware or Firmware support the declared TechnologyType? (0 = no;1 = yes; 2 = yes, but SFP needed)
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.

socketSmallType

Description: Socket (Fiber)

Used by: getServiceStatusResponseType

Element Type Occ Comment
socketId xs:string (minLength:13, maxLength:19) 1..1 A socket id (e.g. A.123.456.789).
cooperationId xs:string (maxLength:100) 0..1 A cooperation id (e.g. FreeFormText).
plugNr xs:int (totalDigits:3) 1..1

serviceStatusServiceType

Description: The service part of a service status response.

Used by: getServiceStatusResponseType

Element Type Occ Comment
contrEleId xs:int (totalDigits:3) 1..1 [LOV-ID: 0320] A contract element ID.
sla sla 0..1
speedProfile speedProfileType 0..1 The speed profile.
speedProfileReq speedProfileType 0..1 A speed profile type.
effectiveSpeed duplexSpeedType 0..1 The effective speed/virtual profile.
bbQuality xs:int (totalDigits:3) 0..1 [LOV-ID: 1009] The BB quality.
classOfService xs:int (totalDigits:3) 0..1 [LOV-ID: 1108] The Class of Service.
fairUseSpeedProfileNr xs:int (totalDigits:3) 0..1 [LOV-ID: 1109] The requested fair use profile Nr (e.g. 0 := "Restore original Service Speed Profile" 1, := "600 down / 100 up").
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.

getServiceStatusResponseType

Description: Reponse of a get service status

Used by: getServiceStatusAckType

Element Type Occ Comment
contrEleId xs:int (totalDigits:3) 0..1 [LOV-ID: 0320] A contract element ID.
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
sla sla 0..1
ispId xs:int (totalDigits:6) 1..1 An ISP ID.
ispName xs:string (minLength:1, maxLength:30) 0..1 The name of the ISP.
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 0..1 A DN/VN/NSN phone number.
billingZone xs:int (totalDigits:3) 0..1 [LOV-ID: 1503] The billing zone.
bbType xs:int (totalDigits:3) 0..1 [LOV-ID: 0276] The BB type.
endPoint endPointType 0..1 An end point (consisting of a DN office and a BB device location) and port information.
startPoint startPointType 0..1
reasonOfPotential reasonOfPotential 0..1 Reason of Potential - why is the Current Access Speed lower then the maximum
bbAccess xs:int (totalDigits:3) 0..1 [LOV-ID: 0205] Info used in manual exception handling.
dnType xs:int (totalDigits:3) 0..1 [LOV-ID: 0109] The DN type.
cableBox cableBox 0..1 The cable box (aka. "Ueberfuehrungspunkt", "UP").
region xs:int (totalDigits:3) 0..1 [LOV-ID: 1501] The region.
nrOfWires xs:int (totalDigits:2) 0..1 The number of wires (only copper).
accessSpeed speedProfileType 0..1 The access profile.
poolType xs:string (minLength:1) 0..1 The DHCP Pool-Type (named item) of the subscriber (e.g. "pool2"); the LOV-ID 1007 shows the currently available Pool-Type names.
cpeInfo cpeInfo 0..1 Information about the CPE.
cpeOwner xs:int (totalDigits:3) 0..1 [LOV-ID: 4006] The CPE owner. (aka "modem owner")
sessionType xs:int (totalDigits:3) 0..1 [LOV-ID: 1005] The session type.
interleaveMode xs:int (totalDigits:3) 0..1 [LOV-ID: 1008] LOV_INTERLEAVE_MODE
termination xs:int (totalDigits:3) 0..1 [LOV-ID: 1006] The termination type.
vectorized xs:boolean 0..1 true if line is currently vectorized
technologyType xs:int (totalDigits:3) 0..1 [LOV-ID: 9025] LOV_TECHNOLOGY_TYPE: Which standard was uesd for bitrate calculation: 1 = VDSL2; 2 = VDSL Vectoring; 3 = G.FAST
opStatus xs:int (totalDigits:3) 0..1 [LOV-ID: 1014] The OP Status.
socket socketSmallType 0..1 A socket (fiber)
service serviceStatusServiceType 0..n The service part of a service status response.

dateTimeRangeType

Description: A range of dateTimes.

Used by: installDateTimeRange, transDateTimeRange, lastModificationDateTimeRange, ticketCreationDateTimeRange

Element Type Occ Comment
from xs:dateTime 1..1
to xs:dateTime 1..1

oldConnectionType

Used by: plugType

Element Type Occ Comment
basisContrEleId xs:int (totalDigits:3) 1..1
ispId xs:int (totalDigits:6) 0..1
patchType xs:int (totalDigits:3) 0..1 [LOV-ID: 1334] LOV_ALO_PATCH_TYPE: Type of the cross connection (V1, V1+, V2)

fiberQualifProfileType

Description: Represents a fiber speed profile making up a part of a qualification result.

Used by: plugType

Element Type Occ Comment
qualifIndex xs:long (totalDigits:10) 0..1 The index identifying a profile within a qualification response.
usedAccessSpeed speedProfileType 0..1 A speed profile type.
serviceSpeed speedProfileType 1..1 A speed profile type.
effectiveSpeed duplexSpeedType 0..1 The effective speed/virtual profile.

plugType

Description: A plug on a Optical Termination Outlet OTO or Fiber Dose FD

Used by: socketType

Element Type Occ Comment
plugNr xs:int (totalDigits:3) 1..1 A plug number (1..4).
fiberLineState xs:int (totalDigits:3) 0..1 [LOV_FIBER_LINE_STATE] The state for the whole fiber line
otoState xs:int (totalDigits:3) 0..1 [LOV_FIBER_LINE_STATE] The state of the OTO (optical termination outlet)
availabilityDate xs:date 0..1
remark xs:string 0..1 a remark
isActive xs:boolean 0..1 true if a service is active on this line
activeConnectionInfo oldConnectionType 0..1 only set in case of isActive=true
maxAccessSpeed speedProfileType 0..1 access profiles
qualifProfile fiberQualifProfileType 0..n qualification profiles
jumperAction xs:boolean 0..1 Ueberfuehrungsrelevant (true/false).
fulfillmentTimeSlot fulfillmentTimeSlot 0..n A list of fulfillment time slots
portState xs:int (totalDigits:3) 0..1 [LOV-ID: 1111] The state of the port 1 = Connected 2 = Available 3 = Planned
portAvailabilityDate xs:dateTime 0..1 Port availability date

socketType

Description: Socket (Fiber)

Used by: customerOrderType, fiberQualifAnswer

Element Type Occ Comment
flatId xs:string (maxLength:6 false) 0..1 A flat id (e.g. 02.01).
flatMemo xs:string (maxLength:64) 0..1
socketId xs:string (minLength:13, maxLength:19) 1..1
cooperationId xs:string (maxLength:100) 0..1 A cooperation id (e.g. FreeFormText).
fiberLineState xs:int (totalDigits:3) 0..1 State of fiber line. Populated here, if no plug exists, else under plug
otoState xs:int (totalDigits:3) 0..1 The state of the OTO (optical termination outlet). Populated here, if no plug exists, else under plug
firstInHouse xs:boolean 0..1 Is this the first socket in the house?
availabilityDate xs:date 0..1
plug plugType 0..n A list of plugs

baseProductOrderType

Description: An order for a base product.

Used by: customerOrderType

Extension of: baseOrderType

Element Type Occ Comment
disconDate xs:date 0..1 The date of service deactivation.
bbType xs:int (totalDigits:3) 0..1 [LOV-ID: 0276] The BB type.
startPoint startPointType 0..1
bbAccess xs:int (totalDigits:3) 0..1 [LOV-ID: 0205] Info used in manual exception handling.
bbPortNr xs:string (minLength:1, maxLength:15) 0..1 Splitter Port
dnType xs:int (totalDigits:3) 0..1 [LOV-ID: 0109] The DN type.
dnVnNsnReq xs:string (pattern:0[1-9]\d{8}) 0..1 The requested DN/VN/NSN.
stnrDdi xs:string (pattern:0[1-9]\d{8}) 0..1 The base number ("Stammnummer") for DDI.
cableBox cableBox 0..1 The cable box (aka. "Ueberfuehrungspunkt", "UP").
region xs:int (totalDigits:3) 0..1 [LOV-ID: 1501] The region.
address addressType 0..1 In case of BBCS standalone
sgMm xs:int (totalDigits:3) 0..1 [LOV-ID: 0107] The "Schalt-Merkmal".
nrOfWires xs:int (totalDigits:2) 0..1 The number of wires (only copper).
accessSpeed speedProfileType 0..1 The access profile.
accessSpeedChange xs:int (totalDigits:3) 0..1 [LOV-ID: 1064] The access speed profile changed.
poolType xs:string (minLength:1) 0..1 The DHCP Pool-Type (named item) of the subscriber (e.g. "pool2"); the LOV-ID 1007 shows the currently available Pool-Type names.
cpeOwner xs:int (totalDigits:3) 0..1 [LOV-ID: 4006] The CPE owner. (aka "modem owner")
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.
appointmentDateTime xs:dateTime 0..1 Date and Time of an Appointment
selfInstall xs:int (totalDigits:3) 0..1 [LOV-ID: 4005] Type of Self Installation.
opStatus xs:int (totalDigits:3) 0..1 [LOV-ID: 1014] The OP Status.
inhouseInstallationInfo inhouseInstallationInfoType 0..1 Information about a fiber in house installation
previousActiveConnectionInfo
Element Type Occ Comment
ispId xs:int (totalDigits:6) 1..1 An ISP ID.
plugNr xs:int (totalDigits:3) 1..1
contrEleId xs:int (totalDigits:3) 1..1 [LOV-ID: 0320] A contract element ID.
nsn xs:string (pattern:010\d{7}) 0..1 A Net Service Number
patchType xs:int (totalDigits:3) 0..1 [LOV-ID: 1334] LOV_ALO_PATCH_TYPE: Type of the cross connection (V1, V1+, V2)
breakout breakoutType 0..1 Breakout cable The name of the breakout cable Number of the Fiber
0..1
predecessorInfo predecessorInfoType 0..1 a predecessor information
jumperAction xs:boolean 0..1 Ueberfuehrungsrelevant (true/false).
preOrderActivationCode xs:string 0..1 The activation code for preOrders
onpNumber xs:string (maxLength:32) 0..1 ONP Nummer (I-NET order)
missingDisconnectInfo missingDisconnectInfoType 0..1 line is still used by a former ISP
history baseProductOrderHistoryType 0..n An order history for a base product.

ispChangeDonorOrderType

Description: An isp change donor order that reports the new isp receiver to the isp donor.

Used by: customerOrderType

Extension of: baseOrderType

Element Type Occ Comment
newIspId xs:int (totalDigits:6) 1..1
newIspName xs:string (minLength:1, maxLength:30) 1..1
history ispChangeDonorOrderHistoryType 0..n An history order of isp change donor order.

serviceOrderType

Description: An order for a service.

Used by: customerOrderType

Extension of: baseOrderType

Element Type Occ Comment
speedProfile speedProfileType 0..1 The speed profile.
speedProfileReq speedProfileType 0..1 A speed profile type.
accessSpeed speedProfileType 0..1 The access profile.
accessSpeedChange xs:int (totalDigits:3) 0..1 [LOV-ID: 1064] The access speed profile changed.
effectiveSpeed duplexSpeedType 0..1 The effective speed/virtual profile.
bbQuality xs:int (totalDigits:3) 0..1 [LOV-ID: 1009] The BB quality.
classOfService xs:int (totalDigits:3) 0..1 [LOV-ID: 1108] The Class of Service.
fairUseSpeedProfileNr xs:int (totalDigits:3) 0..1 [LOV-ID: 1109] The requested fair use profile Nr (e.g. 0 := "Restore original Service Speed Profile" 1, := "600 down / 100 up").
history serviceOrderHistoryType 0..n An order for a service.

baseOrderType

Description: The abstract order definition.

Extended by: baseProductOrderType, ispChangeDonorOrderType, serviceOrderType

Extension of: abstractOrderType

Element Type Occ Comment
creationType xs:int (totalDigits:3) 0..1 [LOV-ID: 1003] The so-called "kind of creation" of an order.
orderNr xs:string (pattern:[1-9]\d{25}) 1..1 The order ID.
contrEleId xs:int (totalDigits:3) 0..1 [LOV-ID: 0320] A contract element ID.
orderType xs:int (totalDigits:3) 1..1 [LOV-ID: 1001] The order type.
orderState xs:int (totalDigits:3) 1..1 [LOV-ID: 1002] The order status.
customerWishDate xs:date 0..1 The customer wish date.
estimatedDueDateTimeStart xs:dateTime 0..1 The estimated due date and time start.
estimatedDueDateTimeEnd xs:dateTime 0..1 The estimated due date and time end.
transDateTime xs:dateTime 1..1 The transition date/time.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.
reason xs:string (pattern:[\dA-Z]{3}) 0..1 A 3-letter error code (aka messageId) where "000" means "ok".
reasonComment xs:string (minLength:1, maxLength:256) 0..1 Some additional textual description for the reason.
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
sla sla 0..1

abstractOrderType

Description: The generic order type used in responses.

Extended by: baseOrderType

inhouseAppointmentType

Description: An inhouse appointment

Used by: inhouseAppointment

Element Type Occ Comment
appointmentId xs:long (totalDigits:10) 1..1 Appointment ID referencing an existing agreement.
appointmentDateTime xs:dateTime 0..1 Date and Time of an Appointment
appointmentEndDateTime xs:dateTime 0..1 End Date and Time of an Appointment
slaAppointmentDateTime xs:dateTime 0..1 SLA Date and Time of an Appointment
slaAppointmentEndDateTime xs:dateTime 0..1 SLA End Date and Time of an Appointment

processingStepType

Used by: processingStep

Element Type Occ Comment
stepCode xs:int (totalDigits:3) 1..1 [LOV-ID: 5012] LOV_FIBER_WFM_FIO_STATE (10 = New; 20 = Waiting; 30 = CustomerPending; 40 = ReadyToClean; 50 = Clean; 60 = Ready; 70 = Forwarded; 80 = Assigned; 100 = Suspended; 110 = Acknowledged; 120 = Rejected; 130 = Accepted; 140 = TripStarted; 150 = InWork; 160 = OnHold; 180 = Completed; 190 = Canceled; 200 = Closed; 210 = Aborted; 230 = Pull)
stepDateTime xs:dateTime 1..1

reportDataType

Description: Information about Order completion

Used by: reportData

Element Type Occ Comment
completionCode xs:int (totalDigits:3) 1..1 [LOV-ID: 5011] LOV_FIBER_COMPLETION_CODE
completionComment xs:string (minLength:1, maxLength:256) 0..1 Further information on the execution by the installation partner

workInfoType

Description: Work information

Used by: workInfo

Element Type Occ Comment
workInfoCode xs:int (totalDigits:3) 1..1 [LOV-ID: 5010] LOV_FIBER_WORKINFO_CODE (10=Order Pending; 20=Customer not reached; 30=Delay for technical reason; 40=Cancel order not possible)
workInfoComment xs:string (minLength:1, maxLength:256) 1..1 Further information on the execution by the installation partner

inventoryDataType

Used by: inventoryData

Element Type Occ Comment
otoType xs:string (maxLength:20) 0..1 example: 4/2
partnerLabel xs:string (maxLength:20) 0..1 cooperation id
installationDate xs:dateTime 0..1 The time as the installation was completed
flatId xs:string (minLength:1, maxLength:6) 0..1 A flat id (e.g. 02.01).
flatMemo xs:string (maxLength:64) 0..1
lengthInhouseCable xs:int 0..1 the cable length between OTO and BEP in meter
inventoryComment xs:string (minLength:1, maxLength:256) 0..1 Comment to the inventory

inhouseInstallationInfoType

Description: Information about a fiber in house installation

Used by: inhouseInstallationInfo

Element Type Occ Comment
ContactAddress contactAddressType 1..1 Customer Contact Information
InstallationNotice xs:string (minLength:1, maxLength:256) 0..1 Comment for dispatching and service engineer
inhouseAppointment inhouseAppointmentType 0..1 An inhouse Appointment
outOfSla xs:boolean 0..1
outOfSlaReason xs:int (totalDigits:3) 0..1 [LOV-ID: 5009] LOV_FIBER_OUTOFSLA_REASON (10 = Appointment outside of SLA due to customer preference; 20 = Appointment outside of SLA caused by Installation Partner Swisscom; 30 = Appointment outside of SLA caused by Installation Partner KoPa)
outOfSlaComment xs:string (minLength:1, maxLength:256) 0..1 Notice text with the reason for Out of SLA
earliestCustomerContact xs:date 0..1 earliest customer contact of the inhouse installation
moveToSameAddress xs:boolean 0..1 enduser moves to another flat in the same building
processingStep processingStepType 0..1
reportData reportDataType 0..1
workInfo workInfoType 0..1
inventoryData inventoryDataType 0..1

breakoutType

Description: Breakout cable

Used by: createType, baseProductOrderType

Element Type Occ Comment
breakoutCable xs:string (minLength:1, maxLength:40) 1..1 The name of the breakout cable
breakoutFiber xs:string (minLength:1, maxLength:30) 0..1 Number of the Fiber

predecessorInfoType

Description: An predecessor Info

Used by: predecessorInfo

Element Type Occ Comment
phoneNr xs:string (pattern:0[1-9]\d{8}) 0..1 The voice phone number.
name subjectAddressNameType 0..1 Person or company name.

missingDisconnectInfoType

Used by: missingDisconnectInfo

Element Type Occ Comment
predecessorDisconnectNeeded xs:boolean 1..1
predecessorDisconnectMissing xs:boolean 0..1
predecessorDnVnNsn xs:string (pattern:0[1-9]\d{8}) 1..1 A nomalized phone number (e.g. "0312223344")
predecessorIspId xs:int (totalDigits:6) 1..1 An isp ID.
predecessorDisconDate xs:date 0..1

baseProductOrderHistoryType

Description: An order history for a base product.

Used by: baseProductOrderType

Extension of: orderHistoryType

Element Type Occ Comment
disconDate xs:date 0..1 The date of service deactivation.
bbType xs:int (totalDigits:3) 0..1 [LOV-ID: 0276] The BB type.
accessSpeed speedProfileType 0..1 The access profile.
accessSpeedChange xs:int (totalDigits:3) 0..1 [LOV-ID: 1064] The access speed profile changed.
poolType xs:string (minLength:1) 0..1 The DHCP Pool-Type (named item) of the subscriber (e.g. "pool2"); the LOV-ID 1007 shows the currently available Pool-Type names.
cpeOwner xs:int (totalDigits:3) 0..1 [LOV-ID: 4006] The CPE owner. (aka "modem owner")

ispChangeDonorOrderHistoryType

Description: An history order of isp change donor order.

Used by: ispChangeDonorOrderType

Extension of: orderHistoryType

serviceOrderHistoryType

Description: An order for a service.

Used by: serviceOrderType

Extension of: orderHistoryType

Element Type Occ Comment
speedProfile speedProfileType 0..1 The speed profile.
speedProfileReq speedProfileType 0..1 A speed profile type.
effectiveSpeed duplexSpeedType 0..1 The effective speed/virtual profile.
bbQuality xs:int (totalDigits:3) 0..1 [LOV-ID: 1009] The BB quality.

orderHistoryType

Description: The abstract order history definition.

Extended by: baseProductOrderHistoryType, ispChangeDonorOrderHistoryType, serviceOrderHistoryType

Element Type Occ Comment
orderState xs:int (totalDigits:3) 1..1 [LOV-ID: 1002] The order status.
customerWishDate xs:date 0..1 The customer wish date.
estimatedDueDateTimeStart xs:dateTime 0..1 The estimated due date and time start.
estimatedDueDateTimeEnd xs:dateTime 0..1 The estimated due date and time end.
transDateTime xs:dateTime 1..1 The transition date/time.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.
reason xs:string (pattern:[\dA-Z]{3}) 0..1 A 3-letter error code (aka messageId) where "000" means "ok".
reasonComment xs:string (minLength:1, maxLength:256) 0..1 Some additional textual description for the reason.
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
sla sla 0..1
fiberInhouseInstallation
Element Type Occ Comment
processingStep processingStepType 1..1 FIO Order State in WFM. Only set for Incoming FIOs
0..1

customerOrderType

Description: The generic customer order type.

Used by: getDetailAckType

Element Type Occ Comment
ispId xs:int (totalDigits:6) 1..1 An ISP ID.
ispName xs:string (minLength:1, maxLength:30) 1..1 The name of the ISP.
customerOrderNr xs:string (pattern:[1-9]\d{25}) 1..1 The customer order ID.
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 0..1 A DN/VN/NSN phone number.
businessType xs:int (totalDigits:3) 0..1 [LOV-ID: 1301] 1=New; 2=Relocation; 3=ProductChange; 4=NewOnActive; 5=IspChange ...
creationType xs:int (totalDigits:3) 0..1 [LOV-ID: 1003] The so-called "kind of creation" of an order.
reason xs:string (pattern:[\dA-Z]{3}) 0..1 A 3-letter error code (aka messageId) where "000" means "ok".
reasonComment xs:string (minLength:1, maxLength:256) 0..1 Some additional textual description for the reason.
qualifNr xs:long (totalDigits:10) 0..1 The qualification ID.
qualifIndex xs:long (totalDigits:10) 0..1 The index identifying a profile within a qualification response.
fulfillmentTimeSlotQualifIndex xs:long (totalDigits:10) 0..1 The index identifying a profile within a qualification response.
billingZone xs:int (totalDigits:3) 0..1 [LOV-ID: 1503] The billing zone.
wosId xs:string (maxLength:17) 0..1 The work order synchronisation ID.
wosIdReq xs:string (maxLength:17) 0..1 The requested work order synchronisation ID.
endPoint endPointType 0..1 An end point (consisting of a DN office and a BB device location) and port information.
reasonOfPotential reasonOfPotential 0..1 Reason of Potential - why is the Current Access Speed lower then the maximum
cpeInfo cpeInfo 0..1 Information about the CPE.
socket socketType 0..1 Socket (Fiber) A flat id (e.g. 02.01). State of fiber line. Populated here, if no plug exists, else under plug The state of the OTO (optical termination outlet). Populated here, if no plug exists, else under plug Is this the first socket in the house? an availability date A list of plugs
order
Element Type Occ Comment
baseProductOrder baseProductOrderType 0..1 An order for a base product. In case of BBCS standalone
serviceOrder serviceOrderType 0..n An order for a service.
ispChangeDonorOrder ispChangeDonorOrderType 0..1 An isp change donor order that reports the new isp receiver to the isp donor. The ISP ID of the new ISP (receiver). The name of the new ISP (receiver).
1..1 A list of orders (E.g. base or service order).
sessionType xs:int (totalDigits:3) 0..1 [LOV-ID: 1005] The session type.
termination xs:int (totalDigits:3) 0..1 [LOV-ID: 1006] The termination type.
vectorized xs:boolean 0..1 true if line is currently vectorized
technologyType xs:int (totalDigits:3) 0..1 [LOV-ID: 9025] LOV_TECHNOLOGY_TYPE: Which standard was uesd for bitrate calculation: 1 = VDSL2; 2 = VDSL Vectoring; 3 = G.FAST

additionalInstallationSupport

Description: The additional installation support with it's state.

Used by: ticket

Element Type Occ Comment
additionalInstallationReq xs:int (totalDigits:3) 1..1 [LOV-ID: 4004] The requested additional installation support.
aiState xs:int (totalDigits:3) 1..1 [LOV-ID: --] The additional installation support state.

billingInformation

Description: Billing relevant informations.

Used by: itHistoryType, ticket

Element Type Occ Comment
billingAction xs:int (totalDigits:3) 1..1 [LOV-ID: 1502] Billing actions.
matCost xs:decimal (totalDigits:10) 0..1 Total material costs in CHF. (example: '12.25'; pattern: '10d.2d')
ppId xs:int (totalDigits:3) 0..1 Flat rate code in CHF. (E.g. 7 = xxx CHF)
ppCount xs:int (totalDigits:3) 0..1 Number of flat rates per TT. (Generally 1)
stdId xs:int (totalDigits:3) 0..1 Expense ratio code. (E.g. 01=140 CHF, 02=120 CHF)
expense xs:int (totalDigits:5) 0..1 Work expense in minutes. (Conversion into hours and multiply with STD_ID rate not done)

itHistoryType

Description: A base type for installation tickets (used for history-items).

Used by: ticket

Element Type Occ Comment
itState xs:int 1..1 [LOV-ID: 4001] The WSG state of an installation ticket: 1=ENTERED; 2=REJECTED; 3=CHECKED; 4=PROCESSING; 5=INWORK; 6=CLOSED; 7=CANCELLED).
lastModifiedDateTime xs:dateTime 1..1 The last modification date and time of the corresponding entity.
lastModifiedUsername xs:string (minLength:1, maxLength:60) 1..1 The username of the modifying user.
responseComment xs:string (minLength:1, maxLength:256) 0..1 Text if it is necessary to give some additional detail information. Remark: same attribute as MESSAGE_TEXT in previous .vmg record definitions.
responseCommentCode xs:int (totalDigits:3) 0..1 The response comment code. Code of correction action taken. (LOV).
progressComment xs:string (minLength:1, maxLength:256) 0..1 An information about progess
progressCommentCode xs:int (totalDigits:3) 0..1 [LOV-ID: --] The code of the progress information.
progressDateTime xs:dateTime 0..1 The date and time of the progress
billingInformation billingInformation 0..1 Billing relevant informations.
installDateTimeRange dateTimeRangeType 0..1 Installation frame.

ticket

Description: An installation ticket and its details.

Used by: getInstallationTicketDetailAckType

Element Type Occ Comment
onsiteSupport xs:int (totalDigits:3) 0..1
ispItRef xs:string (minLength:1, maxLength:30) 0..1 An external reference (an ID assigned by the ISP) identifying the installation ticket
endUser endUser 1..1 Contact information on the end user (name, phone numbers, etc)
holdFlag xs:boolean 0..1 If set to true the Installation Ticket is hold until Hardware Delivery Date.
hwDeliveryState xs:int (totalDigits:3) 0..1 [LOV-ID: 4007] Hardware Delivery State.
hwDeliveryDate xs:date 0..1 Hardware Delivery Date.
hwDeliveryLocation xs:string (minLength:1, maxLength:128) 0..1 Hardware delivery location
hwType xs:string (minLength:1, maxLength:128) 0..1 CPE Description
hwExtRefReq xs:string (minLength:1, maxLength:128) 0..1 Additional Information if ONSITE_SUPPORT is not set to 1="None": CPE SAP Order-Number of equipment requested
installDateTimeRange dateTimeRangeType 0..1 Installation frame.
installationType xs:string (minLength:1, maxLength:30) 0..1 Additional installation description.
additionalInstallationReq xs:int (totalDigits:3) 0..n [LOV-ID: 4004] The requested additional installation support.
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.
itIdWsg xs:decimal (totalDigits:10) 1..1 Installation ticket id assigned by WSG
itIdSys xs:string (maxLength:30) 0..1 IT system generated number identifying the installation ticket.
refOrderNr xs:string (pattern:[1-9]\d{25}) 0..1
ispId xs:int (totalDigits:6) 1..1 An ISP ID.
ispName xs:string (minLength:1, maxLength:30) 1..1 The name of the ISP.
orderType xs:int (totalDigits:3) 0..1 [LOV-ID: 1001] The order type.
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 0..1
dnVnNsnReq xs:string (pattern:0[1-9]\d{8}) 0..1 The requested DN/VN/NSN.
entryDateTime xs:dateTime 0..1 The entry dateTime.
closedDateTime xs:dateTime 0..1 The date and time when the ticked has been closed.
contrEleId xs:int (totalDigits:3) 0..1 [LOV-ID: 0320] A contract element ID.
bbType xs:int (totalDigits:3) 0..1 [LOV-ID: 0276] The BB type.
itIdWsgRef xs:decimal (totalDigits:10) 0..1 Reference to installation ticket (2nd intervention)
dnType xs:int (totalDigits:3) 0..1 [LOV-ID: 0109] The DN type.
speedProfileNr xs:int (totalDigits:3) 0..1 [LOV-ID: 1010] The speed profile number.
hwExtRefInst xs:string (minLength:1, maxLength:128) 0..1 CPE SAP Order-Number of equipment installed. Semicolon separate list with Number,Counter pairs. E.g. 5555.676.6,02;555.600.6,01 for 2 CPEs of Order-Number 555.676.6 and 1 CPE of Order-Number 555.600.6
additionalInstallationSupport additionalInstallationSupport 0..n The additional installation support with it's state.
fieldForceComment xs:string (minLength:1, maxLength:256) 0..1 An information from the field force.
wosId xs:string (maxLength:17) 0..1 The work order synchronisation ID.
itState xs:int 1..1 [LOV-ID: 4001] The WSG state of an installation ticket: 1=ENTERED; 2=REJECTED; 3=CHECKED; 4=PROCESSING; 5=INWORK; 6=CLOSED; 7=CANCELLED).
lastModifiedDateTime xs:dateTime 1..1 The last modification date and time of the corresponding entity.
lastModifiedUsername xs:string (minLength:1, maxLength:60) 1..1 The username of the modifying user.
responseComment xs:string (minLength:1, maxLength:256) 0..1 Text if it is necessary to give some additional detail information. Remark: same attribute as MESSAGE_TEXT in previous .vmg record definitions.
responseCommentCode xs:int (totalDigits:3) 0..1 The response comment code. Code of correction action taken. (LOV).
progressComment xs:string (minLength:1, maxLength:256) 0..1 An information about progess
progressCommentCode xs:int (totalDigits:3) 0..1 [LOV-ID: --] The code of the progress information.
progressDateTime xs:dateTime 0..1 The date and time of the progress
billingInformation billingInformation 0..1 Billing relevant informations.
historyItem itHistoryType 0..n A history entry of the ticket

tdmMessageBaseType

Description: A base type for tdm message (used for tdmMessageType and tdmMessageGrouppedPartType).

Extended by: tdmMessage

Element Type Occ Comment
tdmMessageType xs:string (minLength:1, maxLength:40) 1..1 [LOV-ID: 1201] A voice message type. (e.g. 4:="GV04")
tdmMessageRef xs:string (minLength:1, maxLength:40) 1..1 Reference from TERCO or other TDM application.
dnVn1 xs:string (pattern:0[1-9]\d{8}) 1..1
dnVn2 xs:string (pattern:0[1-9]\d{8}) 0..1
responseComment xs:string (minLength:1, maxLength:256) 0..1 Text if it is necessary to give some additional detail information. (free Text)
transDateTime xs:dateTime 0..1
processFlowNr xs:string (minLength:1, maxLength:20) 1..1 Reference from OMS or other Voice application.
validActiDateTime xs:dateTime 0..1
actiDateTime xs:dateTime 0..1
validDisconDateTime xs:dateTime 0..1
disconDateTime xs:dateTime 0..1
dnTypeOld xs:int (totalDigits:3) 0..1 [LOV-ID: 0109] The dn type.
dnTypeNew xs:int (totalDigits:3) 0..1 [LOV-ID: 0109] The dn type.
bbAccess xs:int (totalDigits:3) 0..1 [LOV-ID: 0205] Info used in manual exception handling.
bbTypeOld xs:int (totalDigits:3) 0..1 [LOV-ID: 0276] The Broadband type.
bbTypeNew xs:int (totalDigits:3) 0..1 [LOV-ID: 0276] The Broadband type.
llId xs:string (minLength:1, maxLength:13) 0..1 The local loop ID.
sessionTypeOld xs:int (totalDigits:3) 0..1 [LOV-ID: 1005] Broadband Session Type.
sessionTypeNew xs:int (totalDigits:3) 0..1 [LOV-ID: 1005] Broadband Session Type.
backMessageText xs:string (minLength:1, maxLength:80) 0..1 Free text if it is necessary to give some additional detail information (e.g. port shortage).
cableBox cableBox 0..1 The cable box (aka. "Ueberfuehrungspunkt", "UP").
bbOkStatus xs:int (totalDigits:3) 0..1 [LOV-ID: 1004] BB OK status.
custBusinessNr xs:string (maxLength:12) 1..1 The customer business number.
groupState xs:int 1..1 [LOV-ID: 1202] The state of the tdm message group: 1=OPEN; 2=DELAYED; 3=DONE)
previousGroupState xs:int 0..1 [LOV-ID: 1203] TDM message previous state.
groupType xs:int (totalDigits:3) 1..1 [LOV-ID: 1204] TDM message group type Remark: this type can change until the "tdm message group" has reached the state DONE.
sla sla 0..1
bbQualityOld xs:int (totalDigits:3) 0..1 [LOV-ID: 1009] The bbQuality.
bbQualityNew xs:int (totalDigits:3) 0..1 [LOV-ID: 1009] The bbQuality.
speedProfileOld speedProfileType 0..1 Old service speed profile
speedProfileNew speedProfileType 0..1 New service speed profile
contrEleId xs:int (totalDigits:3) 0..1 [LOV-ID: 0320] A contract element ID.

tdmMessage

Description: TDM message (step).

Used by: getTdmMessageDetailAckType

Extension of: tdmMessageBaseType

Element Type Occ Comment

fulfillmentTimeSlot

Description: A list of fulfillment time slots

Used by: plugType, qualifHistoryReqDataType, qualifAnswer

Element Type Occ Comment
fulfillmentTimeSlotQualifIndex xs:long (totalDigits:10) 1..1 The index identifying a profile within a qualification response.
fulfillmentTimeSlotStart xs:dateTime 1..1 Start Date Time of the Fullfillment Time Slot
fulfillmentTimeSlotEnd xs:dateTime 0..1 End Date Time of the Fullfillment Time Slot

qualifHistoryReqDataType

Description: The qualification request from the history

Used by: getQualifHistoryAckType

Element Type Occ Comment
qualifNr xs:long (totalDigits:10) 1..1 The qualification ID.
qualifIndex xs:long (totalDigits:10) 0..1 The index identifying a profile within a qualification response.
fulfillmentTimeSlot fulfillmentTimeSlot 0..1
ispId xs:int (totalDigits:6) 1..1 An ISP ID.
contrEleId xs:int (totalDigits:3) 1..n [LOV-ID: 0320] A contract element ID.
bbType xs:int (totalDigits:3) 0..n [LOV-ID: 0276] The BB type.
dnType xs:int (totalDigits:3) 0..1 [LOV-ID: 0109] The DN type.
- choice:
Element Type Occ Comment
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 1..1 A DN/VN/NSN phone number.
llId xs:string (minLength:1, maxLength:13) 1..1 The local loop ID.
startPoint startPointRequestType 1..1 start point request parameters
address subjectAddressType 1..1 A subject's postal address.
bindingId xs:string (maxLength:15) 1..1 The binding id (e.g. AC1.222.333.444).
locationId xs:int 1..1 A location id (GAIA ID)
1..1
qualifExtRef xs:string (minLength:1, maxLength:80) 0..1 An external reference (assigned by the ISP) for identification of the qualification request.
customerWishDate xs:date 0..1 The customer wish date.
synchWithVoice xs:boolean 0..1 Synchronize with voice.
lineState xs:int (totalDigits:3) 0..1 [LOV-ID: 1052] The copper line state.
newLoop xs:boolean 0..1 Qualify for a new loop.
sfSlaId xs:int (totalDigits:3) 0..1 [LOV-ID: 0282] The service fulfillment SLA ID.
hasOnp xs:boolean 0..1 Has Operator Number Portabilty
businessType xs:int (totalDigits:3) 0..1 [LOV-ID: 1301] 1=New; 2=Relocation; 3=ProductChange; 4=NewOnActive; 5=IspChange ...
returnSpeedAtNok xs:boolean 0..1 If true speed profiles will be mapped also in case of Copper/Space Shortage
appointment appointmentType 0..1 An Appointment
customerLocationId xs:int 0..1

siteDevelopment

Description: site development information, quantiy of basic connectivities and utilized units

Used by: qualifHistoryResDataType, qualifAnswer

Element Type Occ Comment
fullyDeveloped xs:boolean 1..1 indicates if the site is fully developed
nrOfBasicConnectivities xs:int 0..1 Nr of basic connectivites
nrOfUtilisationUnits xs:int 0..1 Nr of utilisation units
nrOfLinesTotal xs:int 0..1 total number of lines (cable pairs)
nrOfLinesUsable xs:int 0..1 number of free lines (cable pairs)

qualifHistoryResDataType

Description: The qualification response from the history

Used by: getQualifHistoryAckType

Element Type Occ Comment
qualifNr xs:long (totalDigits:10) 0..1 The qualification ID.
dnStnr xs:string (pattern:0[1-9]\d{8}) 0..1 The DN "Stammnummer".
llId xs:string (minLength:1, maxLength:13) 0..1 The local loop ID.
serviceProfile xs:int (totalDigits:3) 0..1 [LOV-ID: 1010] A speed profile number.
availableServiceProfiles
Element Type Occ Comment
nr xs:int (totalDigits:3) 1..n [LOV-ID: 1010] A speed profile number.
0..1
dnType xs:int (totalDigits:3) 0..1 [LOV-ID: 0109] The DN type.
endPoint endPointType 0..1 An end point (consisting of a DN office and a BB device location) and port information.
jumperAction xs:boolean 0..1 Ueberfuehrungsrelevant (true/false).
socketId xs:string (minLength:13, maxLength:19) 0..1
plugNr xs:int (totalDigits:3) 0..1
messageIdLqs xs:string (pattern:[\dA-Z]{3}) 0..1 An error code where '000' indicates 'OK'.
messageIdQualif xs:string (pattern:[\dA-Z]{3}) 0..1 An error code where '000' indicates 'OK'.
reasonComment xs:string (minLength:1, maxLength:256) 0..1 Some additional textual description for the reason.
cpeInfo cpeInfo 0..1 Information about the CPE.
nrOfWires xs:int (totalDigits:2) 0..1 The number of wires (only copper).
technologyType xs:int (totalDigits:3) 0..1 [LOV-ID: 9025] LOV_TECHNOLOGY_TYPE: Which standard was uesd for bitrate calculation: 1 = VDSL2; 2 = VDSL Vectoring; 3 = G.FAST
vectorized xs:boolean 0..1 true if line is currently vectorized
siteDevelopment siteDevelopment 0..1 site development information, quantiy of basic connectivities and utilized units
psdClass xs:int (totalDigits:3) 0..1 [LOV-ID: 1061] LOV_BB_PSD_CLASS
interleaveMode xs:int (totalDigits:3) 0..1 [LOV-ID: 1008] LOV_INTERLEAVE_MODE

qualification

Description: Required if the base product is not BBCS on TDM (Contract Element 110). The qualification Nr is optional for a base product with Contract Element 110. The qualification Nr must be valid and not expired.

Used by: customerOrderRequestType

Element Type Occ Comment
qualifNr xs:long (totalDigits:10) 1..1 The qualification ID.
qualifIndex xs:long (totalDigits:10) 1..1 The index identifying a profile within a qualification response.
fulfillmentTimeSlotQualifIndex xs:long (totalDigits:10) 0..1 The index identifying a profile within a qualification response.

layer2Req

Description: A layer2 type with some required elements.

Used by: createType

Element Type Occ Comment
bbType xs:int (totalDigits:3) 1..1 [LOV-ID: 0276] The BB type.
sessionType xs:int (totalDigits:3) 1..1 [LOV-ID: 1005] The session type.
termination xs:int (totalDigits:3) 0..1 [LOV-ID: 1006] The termination type.
poolType xs:string (minLength:1) 0..1

inhouseInstallationRequestType

Description: Information needed for a fiber in house installation

Used by: inhouseInstallationRequest

Element Type Occ Comment
ContactAddress contactAddressType 1..1 Customer Contact Information
InstallationNotice xs:string (minLength:1, maxLength:256) 0..1 Comment for dispatching and service engineer
earliestCustomerContact xs:date 0..1
moveToSameAddress xs:boolean 0..1 enduser moves to another flat in the same building

createType

Description: Part of a customer order. Purpose: Create a BBCS connection as a base for services.

Extension of: orderRequestType

Element Type Occ Comment
contrEleId xs:int (totalDigits:3) 1..1 [LOV-ID: 0320] A contract element ID.
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
customerWishDate xs:date 0..1 The customer wish date.
disconDate xs:date 0..1 The date of service deactivation.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.
selfInstall xs:int (totalDigits:3) 0..1 [LOV-ID: 4005] Type of Self Installation.
layer2 layer2Req 1..1 A layer2 type with some required elements. Required if SESSION_TYPE is DHCP.
sla sla 0..1
processWithLowPriority xs:boolean 0..1 Process an order with low priority
inhouseInstallationRequest inhouseInstallationRequestType 0..1 Information needed for a fiber in house installation
predecessorInfo predecessorInfoType 0..1 a predecessor information
activeConnectionInfo
Element Type Occ Comment
breakout breakoutType 0..1 Breakout cable The name of the breakout cable Number of the Fiber
0..1 used for product change ALO -> BBCS-F (Connection to disconnect)

disconnectType

Description: Part of a customer order. Purpose: Disconnect all services and the base product.

Extension of: orderRequestType

Element Type Occ Comment
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
customerWishDate xs:date 0..1 The customer wish date.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.
processWithLowPriority xs:boolean 0..1 Process an order with low priority

layer2

Description: Layer2 information.

Used by: modifyPendingBaseOrdType, modifyType, ispChangeType

Element Type Occ Comment
bbType xs:int (totalDigits:3) 0..1 [LOV-ID: 0276] The BB type.
sessionType xs:int (totalDigits:3) 0..1 [LOV-ID: 1005] The session type.
termination xs:int (totalDigits:3) 0..1 [LOV-ID: 1006] The termination type.
poolType xs:string (minLength:1) 0..1

modifyPendingBaseOrdType

Description: Part of a customer order. Purpose: Modify a pending BBCS base product order.

Extension of: orderRequestType

Element Type Occ Comment
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
customerWishDate xs:date 0..1 The customer wish date.
disconDate xs:date 0..1 The date of service deactivation.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.
selfInstall xs:int (totalDigits:3) 0..1 [LOV-ID: 4005] Type of Self Installation.
layer2 layer2 0..1 Layer2 information. Required if SESSION_TYPE is DHCP.
sla sla 0..1
processWithLowPriority xs:boolean 0..1 Process an order with low priority
predecessorInfo predecessorInfoType 0..1 a predecessor information
inhouseInstallationRequest inhouseInstallationRequestType 0..1 Information needed for a fiber in house installation

modifyType

Description: Part of a customer order. Purpose: Modify an installed BBCS base product.

Extension of: orderRequestType

Element Type Occ Comment
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
customerWishDate xs:date 0..1 The customer wish date.
disconDate xs:date 0..1 The date of service deactivation.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.
selfInstall xs:int (totalDigits:3) 0..1 [LOV-ID: 4005] Type of Self Installation.
layer2 layer2 0..1 Layer2 information. Required if SESSION_TYPE is DHCP.
sla sla 0..1
processWithLowPriority xs:boolean 0..1 Process an order with low priority
predecessorInfo predecessorInfoType 0..1 a predecessor information

coCreateIntType

Description: Part of a customer order. Purpose: Create an onsite installation ticket as part of the customer order. Note: The whole customer order will be aborted if a CO_CREATE_INT detail order is submitted without a preceding order for a BBCS service (within the same customer order).

Extension of: orderRequestType

Element Type Occ Comment
onsiteSupport xs:int (totalDigits:3) 0..1
ispItRef xs:string (minLength:1, maxLength:30) 0..1 An external reference (an ID assigned by the ISP) identifying the installation ticket
endUser endUser 1..1 Contact information on the end user (name, phone numbers, etc)
holdFlag xs:boolean 0..1 If set to true the Installation Ticket is hold until Hardware Delivery Date.
hwDeliveryState xs:int (totalDigits:3) 0..1 [LOV-ID: 4007] Hardware Delivery State.
hwDeliveryDate xs:date 0..1 Hardware Delivery Date.
hwDeliveryLocation xs:string (minLength:1, maxLength:128) 0..1 Hardware delivery location
hwType xs:string (minLength:1, maxLength:128) 0..1 CPE Description
hwExtRefReq xs:string (minLength:1, maxLength:128) 0..1 Additional Information if ONSITE_SUPPORT is not set to 1="None": CPE SAP Order-Number of equipment requested
installDateTimeRange dateTimeRangeType 0..1 Installation frame.
installationType xs:string (minLength:1, maxLength:30) 0..1 Additional installation description.
additionalInstallationReq xs:int (totalDigits:3) 0..n [LOV-ID: 4004] The requested additional installation support.
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.

ispChangeType

Description: Part of a customer order. Purpose: Let a recipient ISP order the take over of a BBCS service currently operated by a donor ISP. Note: The ISP_CHANGE detailorder is not sufficient for completing the ISP change operation. At least 1 SRV_ADD must follow within the context of the same logical customer order.

Extension of: orderRequestType

Element Type Occ Comment
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
customerWishDate xs:date 0..1 The customer wish date.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.
selfInstall xs:int (totalDigits:3) 0..1 [LOV-ID: 4005] Type of Self Installation.
layer2 layer2 0..1 Layer2 information. Required if SESSION_TYPE is DHCP.
sla sla 0..1
processWithLowPriority xs:boolean 0..1 Process an order with low priority
predecessorInfo predecessorInfoType 0..1 a predecessor information
onpNumber xs:string (maxLength:32) 0..1 ONP Nummer (I-NET order)

addType

Description: Part of a customer order. Purpose: Add a service to an existing BBCS connection.

Extension of: orderRequestType

Element Type Occ Comment
contrEleId xs:int (totalDigits:3) 1..1 [LOV-ID: 0320] A contract element ID.
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
customerWishDate xs:date 0..1 The customer wish date.
disconDate xs:date 0..1 The date of service deactivation.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.
speedProfileNrReq xs:int (totalDigits:3) 0..1 [LOV-ID: 1010] The requested speed profile number.
sla sla 0..1
processWithLowPriority xs:boolean 0..1 Process an order with low priority
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.
classOfService xs:int (totalDigits:3) 0..1 [LOV-ID: 1108] The Class of Service.

changeType

Description: Part of a customer order. Purpose: Modify an existing service.

Extension of: orderRequestType

Element Type Occ Comment
contrEleId xs:int (totalDigits:3) 1..1 [LOV-ID: 0320] A contract element ID.
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
customerWishDate xs:date 0..1 The customer wish date.
disconDate xs:date 0..1 The date of service deactivation.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.
speedProfileNrReq xs:int (totalDigits:3) 0..1 [LOV-ID: 1010] The requested speed profile number.
sla sla 0..1
processWithLowPriority xs:boolean 0..1 Process an order with low priority
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.
classOfService xs:int (totalDigits:3) 0..1 [LOV-ID: 1108] The Class of Service.
fairUseSpeedProfileNr xs:int (totalDigits:3) 0..1 [LOV-ID: 1109] The requested fair use profile Nr (e.g. 0 := "Restore original Service Speed Profile" 1, := "600 down / 100 up").

modifyPendingSrvOrdType

Description: Part of a customer order. Purpose: Change an existing service related order.

Extension of: orderRequestType

Element Type Occ Comment
contrEleId xs:int (totalDigits:3) 1..1 [LOV-ID: 0320] A contract element ID.
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
customerWishDate xs:date 0..1 The customer wish date.
disconDate xs:date 0..1 The date of service deactivation.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.
speedProfileNrReq xs:int (totalDigits:3) 0..1 [LOV-ID: 1010] The requested speed profile number.
sla sla 0..1
processWithLowPriority xs:boolean 0..1 Process an order with low priority
appointmentId xs:long (totalDigits:10) 0..1 Appointment ID referencing an existing agreement.
classOfService xs:int (totalDigits:3) 0..1 [LOV-ID: 1108] The Class of Service.
fairUseSpeedProfileNr xs:int (totalDigits:3) 0..1 [LOV-ID: 1109] The requested fair use profile Nr (e.g. 0 := "Restore original Service Speed Profile" 1, := "600 down / 100 up").

reduceType

Description: Part of a customer order. Purpose: Remove an installed service.

Extension of: orderRequestType

Element Type Occ Comment
contrEleId xs:int (totalDigits:3) 1..1 [LOV-ID: 0320] A contract element ID.
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
customerWishDate xs:date 0..1 The customer wish date.
comment xs:string (minLength:1, maxLength:256) 0..1 A comment.
processWithLowPriority xs:boolean 0..1 Process an order with low priority

orderRequestType

Description: An abstract order request as part of a customer oder request.

Used by: order

Extended by: createType, disconnectType, modifyPendingBaseOrdType, modifyType, coCreateIntType, ispChangeType, addType, changeType, modifyPendingSrvOrdType, reduceType

Attribute Type Use Comment
correlationId xs:string optional A unique ID to correlate request and answer(s) within a (ansynch.) batch process.

endUser

Description: Contact information on the end user (name, phone numbers, etc)

Used by: createInstallationTicketRequestType, modifyPendingInstallationTicketRequestType, coCreateIntType, ticket

Element Type Occ Comment
name xs:string (minLength:1, maxLength:60) 0..1 A name.
phone xs:string (pattern:(\+)?([0-9]){7,15}) 1..1 A nomalized phone number (e.g. "+41312223344")
comment xs:string (minLength:1, maxLength:2048) 0..1

vnRecord

Description: A business line identity (VN) (= Verrechnungsnummer) record.

Used by: getBusinessLinesAckType

Element Type Occ Comment
vn xs:string 1..1 VN.
cableBox cableBox 0..1 The cable box (aka. "Ueberfuehrungspunkt", "UP").
bbAssigned xs:boolean 0..1 BB already assigned: true="Yes", false="No".
bbInfo xs:string (maxLength:256) 0..1 Additional information.

dslam

Used by: createChangeTicketRequestType, getChangeTicketOverviewResponseType, changeTicketType

Element Type Occ Comment
dslamName xs:string (maxLength:30) 1..1 name of the DSLAM (e.g.: ipc-aar730-s-vd-05)
dslamPort xs:string (maxLength:20) 1..1 DSLAM Port notation (e.g.: 1/1/2/12)

customerContactType

Used by: customerContact1, customerContact2

Element Type Occ Comment
greetingCode xs:int (totalDigits:3) 0..1 [LOV-ID: 9011] LOV_GREETING_CODE Anrede (Mr.,Ms., Firm, Unknown ...)
firstName xs:string (minLength:1, maxLength:30) 0..1 A subject's first name.
lastName xs:string (minLength:1, maxLength:30) 1..1 A subject's last name.
street xs:string (minLength:1, maxLength:30) 0..1 The street name of an address.
houseNr xs:string (minLength:1, maxLength:12) 0..1 The house number of an address.
building xs:string (minLength:1, maxLength:30) 0..1 The building infomation of an address.
streetAppendix xs:string (minLength:1, maxLength:30) 0..1 An additional street information (for instance: Chalet Sonneblick) )
zip xs:int (minInclusive:1000, maxInclusive:999999) 0..1 The zip of an address.
city xs:string (minLength:1, maxLength:25) 0..1 The city of an address.
eMail xs:string (minLength:5, maxLength:100) 0..1 An email address
mobilePhone xs:string (pattern:(\+)?([0-9]){7,15}) 0..1 Mobile phone number
language xs:string 1..1 ISO 639-1 (Codes for the representation of names of languages) (de = german; fr = french; it = italian)
communicationChannel xs:int (totalDigits:3) 1..1 [LOV-ID: 3020] The way the customer should be notified

dnNsnRangeType

Used by: dnNsnRange

Element Type Occ Comment
from xs:string (pattern:0[1-9]\d{8}) 1..1 A nomalized phone number (e.g. "0312223344")
to xs:string (pattern:0[1-9]\d{8}) 0..1 A nomalized phone number (e.g. "0312223344")

changeTicketType

Used by: changeTicket, historyItem

Element Type Occ Comment
ispId xs:int (totalDigits:6) 1..1 An ISP ID.
changeTicketId xs:decimal (totalDigits:10) 1..1 Change Ticket ID assigned by WSG
changeTicketStatus xs:int (totalDigits:3) 1..1 [LOV-ID: 3021 Change Ticket Status
statusReason xs:int (totalDigits:3) 0..1 [LOV-ID: 3022] A Status Reason set by the backend system
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
- choice:
Element Type Occ Comment
dnNsn xs:string (pattern:0[1-9]\d{8}) 1..1 A DN/NSN phone number.
dslam dslam 1..1
1..1
exchangeDate xs:date 1..1 designated date for the exchange
exchangeType xs:int (totalDigits:3) 1..1 [LOV-ID: 3020] What must be exchanged (1 = CPE Hardware: 2 = CPE Firmware)
reminderProcess xs:int (totalDigits:3) 1..1 [LOV-ID: 9012] LOV_REMINDER_PROCESS (1 = first reminder at exchange date, second reminder after 5 days ; 2 = first reminder at exchange date, no second reminder)
customerContact1 customerContactType 1..1
customerContact2 customerContactType 0..1 Customer Contact 2
creationDateTime xs:dateTime 1..1
lastModificationDateTime xs:dateTime 1..1

workLogType

Used by: getChangeTicketDetailResponseType

Element Type Occ Comment
workLogDateTime xs:dateTime 1..1
workLogSummary xs:string (minLength:1, maxLength:100) 1..1 A summary of the work log entry.
workLogNotes xs:string (maxLength:32768) 0..1 An additional comprehensive description.

predecessorEntityType

Description: An predecessor Entity

Used by: predecessorEntity

Extension of: predecessorEntitySmallType

Element Type Occ Comment
predecessorEntityId xs:long 1..1 The predecessor entity id.
lastModifiedDateTime xs:dateTime 1..1 The last modification date and time of the corresponding entity.
lastModifiedUsername xs:string (minLength:1, maxLength:60) 1..1 The username of the modifying user.
entryDateTime xs:dateTime 1..1 The entry dateTime.
entryUserName xs:string (minLength:1, maxLength:60) 1..1 The username who added the 1st entry.

predecessorEntitySmallType

Used by: predecessorEntities

Extended by: predecessorEntityType

Element Type Occ Comment
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 0..1 A DN/VN/NSN phone number.
predecessorName subjectAddressNameType 0..1
predecessorAddress subjectAddressType 1..1 The address of the predecessor
locationId xs:int 0..1 A location id (GAIA ID)
llId xs:string (minLength:1, maxLength:13) 0..1 The local loop ID.
lastModifiedDate xs:date 0..1 The last modification date of the corresponding entity.

predecessorAddressType

Used by: predecessorAddresses

Element Type Occ Comment
predecessorAddress subjectAddressType 1..1 The address of the predecessor
locationId xs:int 0..1 A location id (GAIA ID)

lookUpPredecessorEntitiesType

Description: the response for hte lookup entities call

Used by: lookUpPredecessorEntities

rescheduleFIOAppointmentRequestType

Description: Request for a time shift of an existing appointment

Used by: rescheduleFIOAppointmentRequest

Element Type Occ Comment
ispId xs:int (totalDigits:6) 1..1 An ISP ID.
orderNr xs:string (pattern:[1-9]\d{25}) 1..1 The order ID.
startDateTime xs:dateTime 1..1
endDateTime xs:dateTime 0..1

fioAppointmentTimeSlotType

Description: A FIO Appointment time slot

Used by: fioAppointmentTimeSlots

Element Type Occ Comment
timeSlotId xs:string (maxLength:40) 1..1
start xs:dateTime 1..1 the beginning
end xs:dateTime 1..1 latest end
duration xs:int 1..1 the expected duration in minutes
rank xs:int 1..1 Preference by the system (ascending sort order)

fioAppointmentTimeSlots

Description: inhouse installation appointments time slots

Used by: rescheduleFIOAppointmentResponseType, fiberQualifAnswer

Element Type Occ Comment
timeSlots fioAppointmentTimeSlotType 1..n A FIO Appointment time slot the beginning latest end the expected duration in minutes Preference by the system (ascending sort order)

bookFIOAppointmentRequestType

Description: reserve a time slot

Used by: bookFIOAppointmentRequest

Element Type Occ Comment
ispId xs:int (totalDigits:6) 1..1 An ISP ID.
orderNr xs:string (pattern:[1-9]\d{25}) 1..1 The order ID.
timeSlotId xs:string (maxLength:40) 1..1
reasonComment xs:string (minLength:1, maxLength:256) 1..1