API Reference
Request Fields by Service Type
Which attrList fields are relevant for each service type. OM sends all fields — empty strings are acceptable.
📝
OM sends all parameters regardless of service type
OM always sends the complete set of parameters in the SOAP payload. Fields not applicable to the current service type are sent as empty strings. IM ignores empty values for non-applicable fields.
Field Applicability by Service Type
| Field | ADSL/VDSL | FTTH | IPTV | IP-Phone | Option Pack | Domain/Email |
|---|---|---|---|---|---|---|
| ExchangeID / Dslamname | ✓ | – | – | – | – | – |
| FrameNumber / SlotNumber / PortNumber | ✓ | – | – | – | – | – |
| DslamIP / DSLAM | ✓ | – | – | – | – | – |
| Speed | ✓ | – | – | – | – | – |
| OLTName / VLAN / ONT SN | – | ✓ | ✓ | ✓ | – | – |
| CompoundId | – | ✓ | ✓ | ✓ | – | – |
| WANIP / SubnetMask / LANIP | – | – | – | – | ✓ | – |
| IPTVPassword / IPTVContent | – | – | ✓ | – | – | – |
| IPAddress / SIPDomainName | – | – | – | ✓ | – | – |
| VoiceOfferID / VoiceOfferName | – | – | – | ✓ | – | – |
| DomainName | – | – | – | – | – | ✓ |
| ParentUserName / ChildUsername | – | – | – | – | – | – |
| UserName / Password | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| CustomerOrderID / AccountNumber | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| AreaCode / Serviceno | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
opertype Values
Install
New subscriber provisioning. Creates customer and service records in IM.
Modify
Modification to existing service (speed change, address change, etc.).
Delete
Service termination. Marks the service as deactivated in IM.
Query
Lookup/verification operation. Does not modify any data.
coverType / serviceType Values
ADSL
Asymmetric DSL broadband
VDSL
Very-high-speed DSL broadband
FTTH
Fiber to the Home