WSG Information Service - WEB Outbound (v8.0.2)

Operations

createReport

Description: Request to generate a Report

Input message Output message
createReportRequest createReportResponse

listReports

Description: Lists all generated and available Reports

Input message Output message
listReportsRequest listReportsResponse

getReport

Description: Gets a generated and available Report

Input message Output message
getReportRequest getReportResponse

uploadFile

Description: Upload a new file

Input message Output message
uploadFileRequest uploadFileResponse

downloadFile

Description: Download an existing file

Input message Output message
downloadFileRequest downloadFileResponse

listFiles

Description: List existing files

Input message Output message
listFilesRequest listFilesResponse

listMigrationProjects

Input message Output message
listMigrationProjectsRequest listMigrationProjectsResponse

getMigrationProjectDetail

Input message Output message
getMigrationProjectDetailRequest getMigrationProjectDetailResponse

createClarificationTicket

Input message Output message
createClarificationTicketRequest createClarificationTicketResponse

updateClarificationTicket

Input message Output message
updateClarificationTicketRequest updateClarificationTicketResponse

cancelClarificationTicket

Input message Output message
cancelClarificationTicketRequest cancelClarificationTicketResponse

getClarificationTicketOverview

Input message Output message
getClarificationTicketOverviewRequest getClarificationTicketOverviewResponse

getClarificationTicketDetail

Input message Output message
getClarificationTicketDetailRequest getClarificationTicketDetailResponse

validateAddress

Input message Output message
validateAddressRequest validateAddressResponse




Messages

createReportRequest

Element Type Occ Comment
parameters createReportRequest 1..1

createReportResponse

Element Type Occ Comment
parameters createReportResponse 1..1

listReportsRequest

Element Type Occ Comment
parameters listReportsRequest 1..1

listReportsResponse

Element Type Occ Comment
parameters listReportsResponse 1..1

getReportRequest

Element Type Occ Comment
parameters getReportRequest 1..1

getReportResponse

Element Type Occ Comment
parameters getReportResponse 1..1

uploadFileRequest

Element Type Occ Comment
parameters uploadFileRequest 1..1

uploadFileResponse

Element Type Occ Comment
parameters uploadFileResponse 1..1

downloadFileRequest

Element Type Occ Comment
parameters downloadFileRequest 1..1

downloadFileResponse

Element Type Occ Comment
parameters downloadFileResponse 1..1

listFilesRequest

Element Type Occ Comment
parameters listFilesRequest 1..1

listFilesResponse

Element Type Occ Comment
parameters listFilesResponse 1..1

listMigrationProjectsRequest

Element Type Occ Comment
parameters listMigrationProjectsRequest 1..1

listMigrationProjectsResponse

Element Type Occ Comment
parameters listMigrationProjectsResponse 1..1

getMigrationProjectDetailRequest

Element Type Occ Comment
parameters getMigrationProjectDetailRequest 1..1

getMigrationProjectDetailResponse

Element Type Occ Comment
parameters getMigrationProjectDetailResponse 1..1

createClarificationTicketRequest

Element Type Occ Comment
parameters createClarificationTicketRequest 1..1

createClarificationTicketResponse

Element Type Occ Comment
parameters createClarificationTicketResponse 1..1

updateClarificationTicketRequest

Element Type Occ Comment
parameters updateClarificationTicketRequest 1..1

updateClarificationTicketResponse

Element Type Occ Comment
parameters updateClarificationTicketResponse 1..1

cancelClarificationTicketRequest

Element Type Occ Comment
parameters cancelClarificationTicketRequest 1..1

cancelClarificationTicketResponse

Element Type Occ Comment
parameters cancelClarificationTicketResponse 1..1

getClarificationTicketOverviewRequest

Element Type Occ Comment
parameters getClarificationTicketOverviewRequest 1..1

getClarificationTicketOverviewResponse

Element Type Occ Comment
parameters getClarificationTicketOverviewResponse 1..1

getClarificationTicketDetailRequest

Element Type Occ Comment
parameters getClarificationTicketDetailRequest 1..1

getClarificationTicketDetailResponse

Element Type Occ Comment
parameters getClarificationTicketDetailResponse 1..1

validateAddressRequest

Element Type Occ Comment
parameters validateAddressRequest 1..1

validateAddressResponse

Element Type Occ Comment
parameters validateAddressResponse 1..1




Root elements

createReportRequest

Element Type Comment
createReportRequest createReportRequestType

createReportResponse

Element Type Comment
createReportResponse createReportResponseType

listReportsRequest

Element Type Comment
listReportsRequest listReportsRequestType

listReportsResponse

Element Type Comment
listReportsResponse listReportsResponseType

getReportRequest

Element Type Comment
getReportRequest getReportRequestType

getReportResponse

Element Type Comment
getReportResponse getReportResponseType

uploadFileRequest

Element Type Comment
uploadFileRequest uploadFileType

uploadFileResponse

Element Type Comment
uploadFileResponse uploadFileResponseType

downloadFileRequest

Element Type Comment
downloadFileRequest downloadFileType

downloadFileResponse

Element Type Comment
downloadFileResponse downloadFileResponseType

listFilesRequest

Element Type Comment
listFilesRequest listFilesType

listFilesResponse

Element Type Comment
listFilesResponse listFilesResponseType

listMigrationProjectsRequest

Element Type Comment
listMigrationProjectsRequest listMigrationProjectsRequestType

listMigrationProjectsResponse

Element Type Comment
listMigrationProjectsResponse listMigrationProjectsResponseType

getMigrationProjectDetailRequest

Element Type Comment
getMigrationProjectDetailRequest getMigrationProjectDetailRequestType

getMigrationProjectDetailResponse

Element Type Comment
getMigrationProjectDetailResponse getMigrationProjectDetailResponseType

createClarificationTicketRequest

Element Type Comment
createClarificationTicketRequest createClarificationTicketRequestType

createClarificationTicketResponse

Element Type Comment
createClarificationTicketResponse createClarificationTicketResponseType

updateClarificationTicketRequest

Element Type Comment
updateClarificationTicketRequest updateClarificationTicketRequestType

updateClarificationTicketResponse

Element Type Comment
updateClarificationTicketResponse updateClarificationTicketResponseType

cancelClarificationTicketRequest

Element Type Comment
cancelClarificationTicketRequest cancelClarificationTicketRequestType

cancelClarificationTicketResponse

Element Type Comment
cancelClarificationTicketResponse cancelClarificationTicketResponseType

getClarificationTicketOverviewRequest

Element Type Comment
getClarificationTicketOverviewRequest getClarificationTicketOverviewRequestType

getClarificationTicketOverviewResponse

Element Type Comment
getClarificationTicketOverviewResponse getClarificationTicketOverviewResponseType

getClarificationTicketDetailRequest

Element Type Comment
getClarificationTicketDetailRequest getClarificationTicketDetailRequestType

getClarificationTicketDetailResponse

Element Type Comment
getClarificationTicketDetailResponse getClarificationTicketDetailResponseType

validateAddressRequest

Element Type Comment
validateAddressRequest validateAddressRequestType

validateAddressResponse

Element Type Comment
validateAddressResponse validateAddressResponseType




Types

centralOfficeType

Used by: centralOffice

Element Type Occ Comment
taxRegion xs:int 1..1 The tax region (e.g. "62") [NC: OFFICE_CODE]
bbDeviceLocation xs:string (maxLength:32) 1..1 The broad band device location. (e.g. "AES") [NC: LOCATION_SHORT_NAME]

createReportRequestType

Description: Request for a Report. The report will be generated asynchronously

Used by: createReportRequest

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
reportType xs:int (totalDigits:3) 1..1 [LOV-ID: 9034] Type of the report (1- OmdfXmdf; 2-OtoOmdf, 3-OtoSap)
centralOffice centralOfficeType 1..1
onlyActiveLines xs:boolean 0..1 used for report OtoOmdf: if true only active Lines will be listed in the report [NC:OMDF_CONNECTOR_STATUS='Assigned' = activeLine]

createClarificationTicketResponseType

Description: Output Create ClarificationTicket

Used by: createClarificationTicketResponse

Extension of: ackType

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

cancelClarificationTicketResponseType

Description: Output cancel ClarificationTicket

Used by: cancelClarificationTicketResponse

Extension of: ackType

getClarificationTicketDetailResponseType

Description: A list of askSwisscom incidents

Used by: getClarificationTicketDetailResponse

Extension of: ackType

Element Type Occ Comment
incident
Element Type Occ Comment
incidentId xs:decimal (totalDigits:10) 1..1 Incident (Ticket) ID assigned by WSG
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
incidentState xs:int (totalDigits:3) 1..1 [LOV-ID: xx] LOV_COPA_xx_STATE: The state of an incident (ticket)
objectType xs:int (totalDigits:3) 1..1 [LOV-ID: 1101] The objectType for the wsgId, e.g. BBCS-Order = 1 , CoPa Tt = 11
wsgId xs:string (minLength:1, maxLength:30) 0..1 the WsgId referencing the question, e.g OrderId, TroubleTicketId
problemDescription xs:string (minLength:1, maxLength:100) 1..1 the summary of the question to be set raised to Swisscom
problemNotes xs:string (maxLength:32768) 0..1 A detailed description of the problem
workLogList workLogExtendedType 0..n List of the work log entries
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 0..1
otoId xs:string (minLength:13, maxLength:19) 0..1 A OTO id (e.g. A.123.456.789).
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
0..1 List of the work log entries

getClarificationTicketOverviewResponseType

Description: A list of askSwisscom incidents

Used by: getClarificationTicketOverviewResponse

Extension of: ackType

Element Type Occ Comment
list
Element Type Occ Comment
incidentId xs:decimal (totalDigits:10) 1..1 Incident (Ticket) ID assigned by WSG
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
incidentState xs:int (totalDigits:3) 1..1 [LOV-ID: xx] LOV_COPA_xx_STATE: The state of an incident (ticket)
objectType xs:int (totalDigits:3) 1..1 [LOV-ID: 1101] The objectType for the wsgId, e.g. BBCS-Order = 1 , CoPa Tt = 11
wsgId xs:string (minLength:1, maxLength:30) 0..1 the WsgId referencing the question, e.g OrderId, TroubleTicketId
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.
0..n

createReportResponseType

Description: Response of CreateFIO

Used by: createReportResponse

Extension of: ackType

Element Type Occ Comment
reportId xs:int 0..1 Identifier of the report

listReportsResponseType

Description: lists all for a ISP or Copa generated and available reports

Used by: listReportsResponse

Extension of: ackType

Element Type Occ Comment
report
Element Type Occ Comment
reportId xs:int 1..1 Identifier of the report
reportType xs:int (totalDigits:3) 1..1 [LOV-ID: 9034] Type of the report (1- OmdfXmdf; 2-OtoOmdf, 3-OtoSap)
numberOfParts xs:int 1..1 the number of pieces the report is subdivided into
centralOffice centralOfficeType 0..1
creationDateTime xs:dateTime 1..1 DateTime when the report was requested from the backend system
0..n the number of pieces the report is subdivided into DateTime when the report was requested from the backend system

listMigrationProjectsResponseType

Description: lists all migration projects

Used by: listMigrationProjectsResponse

Extension of: ackType

Element Type Occ Comment
project
Element Type Occ Comment
projectId xs:int (totalDigits:3) 1..1 The migration Project ID: 2 CU@Warp,3 Vectoring Access Node, 5 FTTS/FTTB_Migration, FTTS/FTTB_activation,7 Software Upgrade CAN,8 Maintenance - Port Move,9 Maintenance - Shorting (SpectrumManagement)
projectName xs:string (minLength:1, maxLength:256) 1..1 The name of the project
projectDescription xs:string 1..1 The project Description
projectImpact xs:string 1..1 The impact of the project
customerAffected xs:string (minLength:1, maxLength:256) 1..1 Customers impacted, e.g many
projectRollout xs:string (minLength:1, maxLength:256) 1..1 Project Rollout , e.g July 2012 - 2016/2017
migrationReason xs:string (minLength:1, maxLength:256) 1..1 Project migration reason, 51 - Cu@WARP
transactionDateTime xs:dateTime 1..1 The date and time when the file was processed
0..n

getMigrationProjectDetailResponseType

Description: lists all migration projects

Used by: getMigrationProjectDetailResponse

Extension of: ackType

Element Type Occ Comment
migrationElements
Element Type Occ Comment
networkElementType xs:string (minLength:1, maxLength:200) 1..1 The name of the network element
networkElementName xs:string (minLength:1, maxLength:200) 1..1 The name of the network element
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 1..1
customerNotificationId xs:string (minLength:1, maxLength:200) 1..1 The customer notification id
customerNotificationType xs:string (minLength:1, maxLength:512) 1..1 The customer notification id
migrationDate xs:dateTime 1..1 The date and time when the migration took place
duration xs:int 1..1 The duration of the disruption in minutes
transactionDateTime xs:dateTime 1..1 The date and time when the file was processed
accessId xs:string (maxLength:15) 0..1 An access id (e.g. AC1.222.333.444).
0..n

updateClarificationTicketResponseType

Description: Output update ClarificationTicket

Used by: updateClarificationTicketResponse

Extension of: ackType

validateAddressResponseType

Used by: validateAddressResponse

Extension of: ackType

Element Type Occ Comment
location addressType 0..n Address entity
resultCode xs:int (totalDigits:3) 0..1 [LOV-ID: XXXX] 0=OK (one location found); 1=no location found; 2=more than one location found; 3=location list is not complete (too many location found)

getReportResponseType

Description: Report

Used by: getReportResponse

Extension of: ackType

Element Type Occ Comment
report
Element Type Occ Comment
reportId xs:int 1..1 Identifier of the report
partNumber xs:int 1..1 part number (starting with 1)
0..1 Report

ackType

Description: The generic acknowledge response type.

Extended by: createClarificationTicketResponseType, cancelClarificationTicketResponseType, getClarificationTicketDetailResponseType, getClarificationTicketOverviewResponseType, createReportResponseType, listReportsResponseType, listMigrationProjectsResponseType, getMigrationProjectDetailResponseType, updateClarificationTicketResponseType, validateAddressResponseType, getReportResponseType

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

listReportsRequestType

Description: Request to list all for a ISP or Copa generated and available reports

Used by: listReportsRequest

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
centralOffice centralOfficeType 0..1
creationDateTimeRange
Element Type Occ Comment
from xs:dateTime 1..1
to xs:dateTime 1..1
0..1
reportType xs:int (totalDigits:3) 0..1 [LOV-ID: 9034] Type of the report (1- OmdfXmdf; 2-OtoOmdf, 3-OtoSap)

getReportRequestType

Description: Request for an allready generated Report

Used by: getReportRequest

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
reportId xs:int 1..1 Identifier of the report
partNumber xs:int 0..1

reportOtoOmdfType

Used by: reportOtoOmdf

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1
centralOffice centralOfficeType 1..1
creationDateTime xs:dateTime 1..1 DateTime when the report was requested from the backend system
onlyActiveLines xs:boolean 1..1 if true only active lines are listed
row
Element Type Occ Comment
otoId xs:string (maxLength:32) 1..1 An Optical Termination Outlet ID (e.g. A.123.456.789) [NC: OTO_ID]
plugNr xs:int (totalDigits:3) 1..1 A plug number (1..4) [NC: OTO_CONNECTOR ]
otoState xs:string (maxLength:32) 1..1 State of the Optical Termination Outlet (Possible values: Created, Ordered and Built) [NC: OTO_STATE]
communicationDate xs:dateTime 1..1 Marketing Communication Date (BEP) [NC: MARKETING_COMMUNICATION_DATE]
inHouseAllowed xs:string (maxLength:32) 1..1 In house installation allowed (Possible values: Yes, No or 'empty') [NC: INHOUSE_ALLOWED]
omdfName xs:string (maxLength:256) 1..1 Name of the OMDF device [NC: OMDF]
omdfRoomZone xs:string (maxLength:256) 1..1 Name of the Room/Zone where the OMDF is located [NC: ROOM_ZONE]
omdfSubRack xs:string (maxLength:32) 1..1 Name of OMDF subrack Slot where one end of ‘ISP Wire’ is terminated. Subrack is a top level card [NC: OMDF_SUBRACK]
omdfRack xs:string (maxLength:32) 1..1 OMDF rack ID [NC: OMDF_RACK_ID]
omdfSlot xs:string (maxLength:32) 1..1 OMDF slot [NC: OMDF_SLOT]
omdfPort xs:string (maxLength:32) 1..1 OMDF port [NC: ??????]
omdfPortStatus xs:string (maxLength:32) 1..1 OMDF port status (Possible values: Planned, Available and Assigned) [NC: OMDF_CONNECTOR_STATUS]
0..n An Optical Termination Outlet ID (e.g. A.123.456.789) [NC: OTO_ID] A plug number (1..4) [NC: OTO_CONNECTOR ] State of the Optical Termination Outlet (Possible values: Created, Ordered and Built) [NC: OTO_STATE] Marketing Communication Date (BEP) [NC: MARKETING_COMMUNICATION_DATE] In house installation allowed (Possible values: Yes, No or 'empty') [NC: INHOUSE_ALLOWED] Name of the OMDF device [NC: OMDF] Name of the Room/Zone where the OMDF is located [NC: ROOM_ZONE] Name of OMDF subrack Slot where one end of ‘ISP Wire’ is terminated. Subrack is a top level card [NC: OMDF_SUBRACK] OMDF rack ID [NC: OMDF_RACK_ID] OMDF slot [NC: OMDF_SLOT] OMDF port [NC: ??????] OMDF port status (Possible values: Planned, Available and Assigned) [NC: OMDF_CONNECTOR_STATUS]

reportOtoSapType

Used by: reportOtoSap

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
centralOffice centralOfficeType 1..1
creationDateTime xs:dateTime 1..1 DateTime when the report was requested from the backend system
row
Element Type Occ Comment
otoId xs:string (maxLength:32) 1..1 An Optical Termination Outlet ID (e.g. A.123.456.789) [NC: OTO_ID]
plugNr xs:int (totalDigits:3) 1..1 A plug number (1..4) [NC: OTO_CONNECTOR]
omdfName xs:string (maxLength:256) 1..1 Name of the OMDF device [NC: OMDF]
omdfRoomZone xs:string (maxLength:256) 1..1 Name of the Room/Zone where the OMDF is located [NC: OMDF_ROOM_ZONE]
omdfSubRack xs:string (maxLength:32) 1..1 Name of OMDF subrack Slot where one end of ‘ISP Wire’ is terminated. Subrack is a top level card [NC: OMDF_SUBRACK]
omdfRack xs:string (maxLength:32) 1..1 OMDF rack ID [NC: OMDF_RACK_ID]
omdfSlot xs:string (maxLength:32) 1..1 OMDF slot [NC: OMDF_SLOT]
omdfPort xs:string (maxLength:32) 1..1 OMDF port [NC: OMDF_PORT]
xmdfName xs:string (maxLength:256) 1..1 Name of XMDF device where one end of ‘ISP Wire’ is terminated [NC: XMDF]
xmdfRoomZone xs:string (maxLength:256) 1..1 Name of the Room/Zone where the XMDF is located [NC: XMDF_ROOM_ZONE]
xmdfSubRack xs:string (maxLength:32) 1..1 Name of XMDF subrack Slot where one end of ‘ISP Wire’ is terminated. Subrack is a top level card [NC: XMDF_SUBRACK]
xmdfRack xs:string (maxLength:32) 1..1 XMDF rack ID [NC: XMDF_RACK_ID]
xmdfSlot xs:string (maxLength:32) 1..1 XMDF slot [NC: XMDF_SLOT]
xmdfPort xs:string (maxLength:32) 1..1 Name of XMDF Device Connector where one end of ‘ISP Wire’ is terminated [NC: XMDF_PORT]
ohdfName xs:string (maxLength:256) 1..1 Name of OHDF device where another end of ‘ISP Wire’ is terminated [NC: OHDF]
ohdfRoomZone xs:string (maxLength:256) 1..1 Name of the Room/Zone where the OHDF is located [NC: OHDF_ROOM_ZONE]
ohdfSubRack xs:string (maxLength:32) 1..1 Name of OHDF subrack Slot where one end of ‘ISP Wire’ is terminated. Subrack is a top level card [NC: OHDF_SUBRACK]
ohdfRack xs:string (maxLength:32) 1..1 OMDF rack ID [NC: OHDF_RACK_ID]
ohdfSlot xs:string (maxLength:32) 1..1 OHDF slot [NC: OHDF_SLOT]
ohdfPort xs:string (maxLength:32) 1..1 OHDF port [NC: OHDF_PORT]
breakoutCable xs:string (maxLength:256) 1..1 The name of the breakout cable (Fan Cable). Only available for PatchType v2 [NC: COOPERATION_CABLE]
breakoutFiber xs:string (maxLength:32) 1..1 Number of the breakout cable fiber. Only available for PatchType v2 [NC: CABLE_CONNECTOR]
0..n An Optical Termination Outlet ID (e.g. A.123.456.789) [NC: OTO_ID] A plug number (1..4) [NC: OTO_CONNECTOR] Name of the OMDF device [NC: OMDF] Name of the Room/Zone where the OMDF is located [NC: OMDF_ROOM_ZONE] Name of OMDF subrack Slot where one end of ‘ISP Wire’ is terminated. Subrack is a top level card [NC: OMDF_SUBRACK] OMDF rack ID [NC: OMDF_RACK_ID] OMDF slot [NC: OMDF_SLOT] OMDF port [NC: OMDF_PORT] Name of XMDF device where one end of ‘ISP Wire’ is terminated [NC: XMDF] Name of the Room/Zone where the XMDF is located [NC: XMDF_ROOM_ZONE] Name of XMDF subrack Slot where one end of ‘ISP Wire’ is terminated. Subrack is a top level card [NC: XMDF_SUBRACK] XMDF rack ID [NC: XMDF_RACK_ID] XMDF slot [NC: XMDF_SLOT] Name of XMDF Device Connector where one end of ‘ISP Wire’ is terminated [NC: XMDF_PORT] Name of OHDF device where another end of ‘ISP Wire’ is terminated [NC: OHDF] Name of the Room/Zone where the OHDF is located [NC: OHDF_ROOM_ZONE] Name of OHDF subrack Slot where one end of ‘ISP Wire’ is terminated. Subrack is a top level card [NC: OHDF_SUBRACK] OMDF rack ID [NC: OHDF_RACK_ID] OHDF slot [NC: OHDF_SLOT] OHDF port [NC: OHDF_PORT] The name of the breakout cable (Fan Cable). Only available for PatchType v2 [NC: COOPERATION_CABLE] Number of the breakout cable fiber. Only available for PatchType v2 [NC: CABLE_CONNECTOR]

reportOmdfXmdfType

Used by: reportOmdfXmdf

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1
centralOffice centralOfficeType 1..1
creationDateTime xs:dateTime 1..1 DateTime when the report was requested from the backend system
row
Element Type Occ Comment
omdfXmdfRelation xs:string (maxLength:256) 1..1 Realation name
omdfName xs:string (maxLength:256) 1..1 Name of the OMDF device
xmdfName xs:string (maxLength:256) 1..1 Name of the XMDF device
breakoutCable xs:string (maxLength:256) 1..1 The name of the breakout cable (Fan Cable)
cableStatus xs:string (maxLength:32) 1..1 Physical Status of the Breakout Cable. (Cooperation/Fan Cable) Possible Values: Frozen or Available
relationStatus xs:string (maxLength:32) 1..1 Status "Frozen/Available" Possible Values: Installed, Planned, Ordered, Uninstalled or Defective (Only in case of Installed, provisioning is allowed)
lodgerId xs:int (totalDigits:6) 1..1 Available Lodger ID
0..n Realation name Name of the OMDF device Name of the XMDF device The name of the breakout cable (Fan Cable) Physical Status of the Breakout Cable. (Cooperation/Fan Cable) Possible Values: Frozen or Available Status "Frozen/Available" Possible Values: Installed, Planned, Ordered, Uninstalled or Defective (Only in case of Installed, provisioning is allowed) Available Lodger ID

reportUmsaType

Used by: reportUmsa

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
creationDateTime xs:dateTime 1..1 DateTime when the report was requested from the backend system
umsa
Element Type Occ Comment
element
Element Type Occ Comment
service
Element Type Occ Comment
commercialId xs:string (maxLength:32) 0..1 the commercialId in case of COPA the layer1ConnectionId, in case of BBCS-F the NSN
usedAs xs:string (maxLength:32) 1..1 indicates the service how the fiber is used. "BBCS-F", "ALO", "COPALayer1","unknown"
1..1 the commercialId in case of COPA the layer1ConnectionId, in case of BBCS-F the NSN indicates the service how the fiber is used. "BBCS-F", "ALO", "COPALayer1","unknown"
fiber
Element Type Occ Comment
otoId xs:string (maxLength:32) 1..1 An Optical Termination Outlet ID (e.g. A.123.456.789)
plugNr xs:int (totalDigits:3) 1..1 A plug number (1..4)
umsaCase xs:string (maxLength:32) 0..1 UC.0 - OMDF Connector was not changed UC.1 = "if only OMDF Connector has been changed" UC.2.A = "OMDF has been changed but this change in the same room with relation to the old XMDF. Non frozen 'OMDF-XMDF Relation' exists and old patch length is bigger or equal to needed new patch length." UC.2.M = "OMDF has been changed. This change is in the same room without relation to the old XMDF. (Note: Room is the same if 'Room/Zone' of OMDF device and Office are the same). Old patch length is strictly smaller to needed new patch length; or non frozen 'OMDF-XMDF Relation' does not exist" UC.3 - OMDF has been changed. This change is in the different room in the same central office.(Where Room is defined via 'Room/Zone' of OMDF device and Central Office is found through objects hierarchy) UC.4 - OMDF has been changed. New OMDF is in the different central office. (Where central Office is found through objects hierarchy)
neededInteraction xs:int 0..1 indicates if a interaction by the copa/isp is needed 1 = "no partner interaction needed", 2 = "partner has to disconnect the old and recreate the new connection", 3 = "partner has to recreate existing connection of patchtype 3"
accessId xs:string (maxLength:15) 0..1 An binding id (e.g. AC1.222.333.444).
1..1 An Optical Termination Outlet ID (e.g. A.123.456.789) A plug number (1..4) UC.0 - OMDF Connector was not changed UC.1 = "if only OMDF Connector has been changed" UC.2.A = "OMDF has been changed but this change in the same room with relation to the old XMDF. Non frozen 'OMDF-XMDF Relation' exists and old patch length is bigger or equal to needed new patch length." UC.2.M = "OMDF has been changed. This change is in the same room without relation to the old XMDF. (Note: Room is the same if 'Room/Zone' of OMDF device and Office are the same). Old patch length is strictly smaller to needed new patch length; or non frozen 'OMDF-XMDF Relation' does not exist" UC.3 - OMDF has been changed. This change is in the different room in the same central office.(Where Room is defined via 'Room/Zone' of OMDF device and Central Office is found through objects hierarchy) UC.4 - OMDF has been changed. New OMDF is in the different central office. (Where central Office is found through objects hierarchy) indicates if a interaction by the copa/isp is needed 1 = "no partner interaction needed", 2 = "partner has to disconnect the old and recreate the new connection", 3 = "partner has to recreate existing connection of patchtype 3" An binding id (e.g. AC1.222.333.444).
1..n the commercialId in case of COPA the layer1ConnectionId, in case of BBCS-F the NSN indicates the service how the fiber is used. "BBCS-F", "ALO", "COPALayer1","unknown" An Optical Termination Outlet ID (e.g. A.123.456.789) A plug number (1..4) UC.0 - OMDF Connector was not changed UC.1 = "if only OMDF Connector has been changed" UC.2.A = "OMDF has been changed but this change in the same room with relation to the old XMDF. Non frozen 'OMDF-XMDF Relation' exists and old patch length is bigger or equal to needed new patch length." UC.2.M = "OMDF has been changed. This change is in the same room without relation to the old XMDF. (Note: Room is the same if 'Room/Zone' of OMDF device and Office are the same). Old patch length is strictly smaller to needed new patch length; or non frozen 'OMDF-XMDF Relation' does not exist" UC.3 - OMDF has been changed. This change is in the different room in the same central office.(Where Room is defined via 'Room/Zone' of OMDF device and Central Office is found through objects hierarchy) UC.4 - OMDF has been changed. New OMDF is in the different central office. (Where central Office is found through objects hierarchy) indicates if a interaction by the copa/isp is needed 1 = "no partner interaction needed", 2 = "partner has to disconnect the old and recreate the new connection", 3 = "partner has to recreate existing connection of patchtype 3" An binding id (e.g. AC1.222.333.444).
startDateTime xs:dateTime 1..1 The start date/time of the disruption
endDateTime xs:dateTime 0..1 The end date/time of the disruption
duration xs:int 0..1 The duration of the disruption in minutes
umsaId xs:string (maxLength:256) 1..1 the umsaId e.g. changeRequest001
umsaType xs:string (maxLength:256) 1..1 the umsaType e.g. Change
1..1 The useCase of the UMSA the commercialId in case of COPA the layer1ConnectionId, in case of BBCS-F the NSN indicates the service how the fiber is used. "BBCS-F", "ALO", "COPALayer1","unknown" An Optical Termination Outlet ID (e.g. A.123.456.789) A plug number (1..4) UC.0 - OMDF Connector was not changed UC.1 = "if only OMDF Connector has been changed" UC.2.A = "OMDF has been changed but this change in the same room with relation to the old XMDF. Non frozen 'OMDF-XMDF Relation' exists and old patch length is bigger or equal to needed new patch length." UC.2.M = "OMDF has been changed. This change is in the same room without relation to the old XMDF. (Note: Room is the same if 'Room/Zone' of OMDF device and Office are the same). Old patch length is strictly smaller to needed new patch length; or non frozen 'OMDF-XMDF Relation' does not exist" UC.3 - OMDF has been changed. This change is in the different room in the same central office.(Where Room is defined via 'Room/Zone' of OMDF device and Central Office is found through objects hierarchy) UC.4 - OMDF has been changed. New OMDF is in the different central office. (Where central Office is found through objects hierarchy) indicates if a interaction by the copa/isp is needed 1 = "no partner interaction needed", 2 = "partner has to disconnect the old and recreate the new connection", 3 = "partner has to recreate existing connection of patchtype 3" An binding id (e.g. AC1.222.333.444). the umsaId e.g. changeRequest001 the umsaType e.g. Change

downloadFileType

Used by: downloadFileRequest

Extension of: requestType

Element Type Occ Comment
irIdWsg xs:decimal (totalDigits:10) 1..1 Information request id.

listFilesType

Used by: listFilesRequest

Extension of: requestType

Element Type Occ Comment
irIdWsgFrom xs:decimal (totalDigits:10) 0..1 Information request id.
irIdWsgTo xs:decimal (totalDigits:10) 0..1 Information request id.
objectState xs:int (totalDigits:3) 0..1 [LOV-ID: 1103] The objectState of the object that triggered the notification
objectType xs:int (totalDigits:3) 1..1
irDateTimeFrom xs:dateTime 0..1 The date and time when the file was processed
irDateTimeTo xs:dateTime 0..1 The date and time when the file was processed

updateFileStatusType

Extension of: requestType

Element Type Occ Comment
objectStep xs:int (totalDigits:3) 1..1 [LOV-ID: 1104] The objectStep of the Object [20=rejected,21=transferred,22=accepted]
comment xs:string (minLength:1, maxLength:256) 0..1 A comment
- choice:
Element Type Occ Comment
irIdWsg xs:decimal (totalDigits:10) 1..1 Information request id.
fileName xs:string (minLength:1, maxLength:150) 1..1 The name of the file
1..1

uploadFileType

Used by: uploadFileRequest

Extension of: requestType

Element Type Occ Comment
fileName xs:string (minLength:1, maxLength:150) 1..1 The name of the file
fileContent xs:base64Binary 1..1 The binary content of the file

validateAddressRequestType

Used by: validateAddressRequest

Extension of: requestType

Element Type Occ Comment
address addressType 1..1 Address entity

requestType

Description: The abstract generic request message type.

Extended by: downloadFileType, listFilesType, updateFileStatusType, uploadFileType, validateAddressRequestType

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]

downloadFileResponseType

Used by: downloadFileResponse

Extension of: responseType

Element Type Occ Comment
fileInformation fileInformationType 1..1 Detailed information about the file
fileContent xs:base64Binary 1..1 The binary content of the file

listFilesResponseType

Used by: listFilesResponse

Extension of: responseType

Element Type Occ Comment
fileInformation fileInformationType 0..n Detailed information about the file

fileInformationType

Description: Information about a file

Used by: fileInformation

Extension of: fileInformationBaseType

Element Type Occ Comment
irIdWsg xs:decimal (totalDigits:10) 1..1 Information request id.
fileName xs:string (minLength:1, maxLength:150) 1..1 The name of the file
objectType xs:int (totalDigits:3) 1..1
initiator xs:int (totalDigits:3) 1..1 [LOV-ID: 1106] The initiator of the object
activator xs:int (totalDigits:3) 1..1 [LOV-ID: 1105] The activator of the object

fileInformationBaseType

Description: Information about a file

Used by: fileInformationHistory

Extended by: fileInformationType

Element Type Occ Comment
irDateTime xs:dateTime 1..1 The date and time when the file was processed
objectStep xs:int (totalDigits:3) 1..1 [LOV-ID: 1104] The objectStep of the Object [20=rejected,21=transferred,22=accepted]
objectState xs:int (totalDigits:3) 1..1 [LOV-ID: 1103] The objectState of the object that triggered the notification
comment xs:string (minLength:1, maxLength:256) 1..1 A comment

updateFileStatusResponseType

Extension of: responseType

Element Type Occ Comment
fileInformation fileInformationType 1..1 Detailed information about the file
fileInformationHistory fileInformationBaseType 1..1 The file information history

uploadFileResponseType

Used by: uploadFileResponse

Extension of: responseType

Element Type Occ Comment
irIdWsg xs:decimal (totalDigits:10) 1..1 Information request id.

responseType

Description: The generic response message type.

Extended by: downloadFileResponseType, listFilesResponseType, updateFileStatusResponseType, uploadFileResponseType

Element Type Occ Comment
success xs:boolean 1..1 The flag indicating success or failure: True if request succeeded, false if not.
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

listMigrationProjectsRequestType

Description: lists all migration projects

Used by: listMigrationProjectsRequest

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]

getMigrationProjectDetailRequestType

Description: lists all migration projects

Used by: getMigrationProjectDetailRequest

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
projectId xs:int (totalDigits:3) 1..1 The migration Project ID: 2 CU@Warp,3 Vectoring Access Node, 5 FTTS/FTTB_Migration, FTTS/FTTB_activation,7 Software Upgrade CAN,8 Maintenance - Port Move,9 Maintenance - Shorting (SpectrumManagement)
migrationDateFrom xs:dateTime 0..1 The date and time when the migration started
migrationDateTo xs:dateTime 0..1 The date and time when the migration started
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 0..1
networkElementName xs:string (minLength:1, maxLength:200) 0..1 The name of the network element
customerNotificationId xs:string (minLength:1, maxLength:200) 0..1 The customer notification id
transactionDateFrom xs:dateTime 0..1 The date and time when the element was added
transactionDateTo xs:dateTime 0..1 The date and time when the element was added
accessId xs:string (maxLength:15) 0..1 An access id (e.g. AC1.222.333.444).

createClarificationTicketRequestType

Description: Request for creating a SwisscomIncident Request

Used by: createClarificationTicketRequest

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
objectType xs:int (totalDigits:3) 1..1
wsgId xs:string (minLength:1, maxLength:30) 0..1
problemDescription xs:string (minLength:1, maxLength:100) 1..1 the summary of the question to be set raised to Swisscom
problemNotes xs:string (maxLength:32768) 0..1 A detailed description of the problem
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.

workLogExtendedType

Used by: getClarificationTicketDetailResponseType

Extension of: workLogResponseType

Element Type Occ Comment
workLogDateTime xs:dateTime 1..1 Creation DateTime of the Work Log Entry

workLogResponseType

Extended by: workLogExtendedType

Extension of: workLogSimpleType

workLogRequestType

Used by: workLog

Extension of: workLogSimpleType

Element Type Occ Comment
attachment
Element Type Occ Comment
fileName xs:string (minLength:1, maxLength:150) 1..1 The name of the file
fileContent xs:base64Binary 1..1
0..1 The binary content of the file, please limit the summary size of all the contens to 2Mb. Otherwise perform mutliple files and use updateIncident

workLogSimpleType

Extended by: workLogResponseType, workLogRequestType

Element Type Occ Comment
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.

updateClarificationTicketRequestType

Description: Request for creating a SwisscomIncident Request

Used by: updateClarificationTicketRequest

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
incidentId xs:decimal (totalDigits:10) 1..1 Incident (Ticket) ID assigned by WSG
workLog workLogRequestType 1..1 A work log entry including attachments

cancelClarificationTicketRequestType

Description: Request for cancel a SwisscomIncident Request

Used by: cancelClarificationTicketRequest

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
incidentId xs:decimal (totalDigits:10) 1..1 Incident (Ticket) ID assigned by WSG

dateTimeRangeType

Used by: getClarificationTicketOverviewRequestType

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

getClarificationTicketOverviewRequestType

Description: Request for a list of askSwisscom incidents

Used by: getClarificationTicketOverviewRequest

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
incidentIdRange
Element Type Occ Comment
from xs:decimal (totalDigits:10) 1..1 Incident (Ticket) ID assigned by WSG
to xs:decimal (totalDigits:10) 0..1 Incident (Ticket) ID assigned by WSG
0..1 The incidentId must be between the values given in 'from' and 'to'
incidentCreationRange dateTimeRangeType 0..1 The incident creation date time must be between the values given in 'from' and 'to'
incidentModificationRange dateTimeRangeType 0..1 The last modification of the incident must be between the values given in 'from' and 'to'
incidentState xs:int (totalDigits:3) 0..n
objectType xs:int (totalDigits:3) 0..n [LOV-ID: 1101] The objectType for the wsgId, e.g. BBCS-Order = 1 , CoPa Tt = 11
wsgIdRange
Element Type Occ Comment
from xs:string (minLength:1, maxLength:30) 1..1 The WsgId referencing the clarification ticket, e.g OrderId, TroubleTicketId
to xs:string (minLength:1, maxLength:30) 0..1 The WsgId referencing the clarification ticket, e.g OrderId, TroubleTicketId
0..1 wsgId referencing the clarification ticket, e.g OrderId, TroubleTicketId must be between the values given in 'from' and 'to'
dnVnNsn xs:string (pattern:0[1-9]\d{8}) 0..1
otoId xs:string (minLength:13, maxLength:19) 0..1 A OTO id (e.g. A.123.456.789).
extRef xs:string (minLength:1, maxLength:80) 0..1 An external reference provided by the ISP.

getClarificationTicketDetailRequestType

Description: Request for a detail of askSwisscom incidents

Used by: getClarificationTicketDetailRequest

Element Type Occ Comment
ispCopaId xs:int (totalDigits:6) 1..1 ISP ID or CoPa ID [NC: RIGHT_OF_USE]
incidentId xs:decimal (totalDigits:10) 1..1 Incident (Ticket) ID assigned by WSG

addressType

Description: Address entity

Used by: validateAddressRequestType, validateAddressResponseType

Element Type Occ Comment
street xs:string 0..1
houseNr xs:string 0..1
building xs:string 0..1
zip xs:int (totalDigits:6) 0..1
city xs:string 0..1
locationId xs:string 0..1