Transactions
ServiceOrderRequest
Purpose |
Transaction Group |
Version |
Use |
---|---|---|---|
Submit Service Order Request to the Service Provider |
SORD |
r_41 |
optional |
Business field |
Restrictions |
aseXML |
Schema |
---|---|---|---|
ServiceOrderRequest |
ServiceOrderRequest |
ServiceOrder_r41 |
|
ActionType |
Mandatory default=New |
ServiceOrder_r41 |
|
ServiceOrderID |
Mandatory If the ActionType = Cancel, must be a previously sent number. Otherwise (ActionType = New or Replace). Must be a new (unused) number, unique for the Initiator/Recipient combination. |
ServiceOrder/ServiceOrderHeader/ServiceOrderNumber/UniqueIdentifier |
Common_r41 |
InitiatorID |
Mandatory |
/Header/From PartyIdentifier |
Common_r41 |
RecipientID |
Mandatory |
/Header/To PartyIdentifier |
Common_r41 |
NotifiedPartyID |
Optional or Not relevant when sending to Notified Parties separately. See B2B Procedure: Service Order Process. Not relevant for Cancelled. |
NotifiedParties/NotifiedPartyID/PartyIdentifier |
OneWayNotification_r41 |
ServiceOrderType |
Not relevant for Cancelled, otherwise Mandatory. |
ServiceOrder/ServiceOrderHeader/ServiceOrderTypeBase/ServiceOrderType |
ServiceOrder_r41 Electricity_r41 |
ServiceOrderSubType |
Mandatory for all Service Orders except: Special Read Miscellaneous Cancel For more details, See B2B Procedure: Service Order Process. |
ServiceOrder/ServiceOrderHeader/ServiceOrderTypeBase/ServiceOrderSubType |
ServiceOrder_r41 Electricity_r41 |
De-EnergisationReason |
Not relevant |
De-energisationReason |
ElectricityEnumerations |
ConfirmedDe-energisation |
Mandatory for De-energisation type. Not relevant for other types or Cancelled. |
xsd:Boolean |
Common_r41 |
ServiceTime |
Not relevant for Cancelled. |
Electricity_r36 |
|
NMI |
Mandatory |
ServiceOrder/ServiceOrderHeader/NMI |
ServiceOrder_r41 Common_r41 |
NMIChecksum |
Not relevant |
ServiceOrder/ServiceOrderHeader/NMI/NMIChecksum |
ServiceOrder_r41 Common_r41 |
MeterSerialNumber |
Not relevant If requested work affects all meters, see B2B Guide. For a Cancel Request. |
ElectricityMeters/ElectricityMeter/SerialNumber/MeterSerialNumber |
Common_r41 |
ServiceOrderAddress |
Not relevant |
ServiceOrder/ServiceOrderHeader/Address |
ServiceOrder_r41 ClientInformation_r36 |
HazardDescription |
Not relevant for: Cancelled Supply Service Works Allocate NMI Supply Service Works Tariff Change |
ServicePoint/SiteHazard |
Common_r41 |
AccessDetails |
Not relevant for: Cancelled Supply Service Works Allocate NMI Supply Service Works Tariff Change Required for Miscellaneous Otherwise Mandatory |
ServicePoint/AccessDetail |
Common_r41 |
LifeSupport |
Mandatory Not relevant for Cancelled |
Common_r41 |
|
FormReference |
Not relevant for: Cancelled Supply Service Works Temporary Isolation – All Supply Service Works Tariff Change Re-energisation De-energisation Special Read Optional for Miscellaneous |
See the Service Paperwork table in the B2B Guide. |
Electricity_r41 |
FormNumber |
If the form listed in FormReference is numbered, populate this field with the form number. Not relevant for: Cancelled Supply Service Works Temporary Isolation – All Supply Service Works: Tariff Change Re-energisation De-energisation Special Read Optional for Miscellaneous |
Electricity_r41 |
|
SafetyCertificateId |
Not relevant for: Cancelled Supply Service Works Temporary Isolation – All Supply Service Works Supply Abolishment Supply Service Works: Tariff Change De-energisation Special Read Optional for Miscellaneous |
License/SafetyCertificateType/ID/ShortUniqueIdentifier |
Common_r41 |
SafetyCertificateMethodSent |
Not relevant for: Cancelled Supply Service Works Temporary Isolation – All Supply Service Works Supply Abolishment Supply Service Works: Tariff Change De-energisation Special Read Optional for Miscellaneous |
License/SafetyCertificateType/MethodSent |
Common_r41 |
MeteringSafetyCertificateID |
Required for: Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Not relevant for Cancelled. |
License/SafetyCertificateType/ID/ShortUniqueIdentifier |
Common_r41 |
MeteringSafetyCertificateMethodSent |
Required for: Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Not relevant for Cancelled. |
License/SafetyCertificateType/MethodSent |
Common_r41 |
SpecialInstructions |
Mandatory if:
|
RequestData/ServiceOrderRequestData/SpecialComments /CommentLine |
ServiceOrder_r41 Common_r41 |
ServiceOrderCo-ordinationRequired |
Yes = if the Initiator has arranged co-ordination for the work completion. No = if no arrangement is made. Not relevant for Cancelled. If SpecialInstructions provided then Required. |
Common_r41 |
|
Co-ordinatingContactName |
Mandatory if ServiceOrderCo-ordinationRequired = Yes. Not relevant for Cancelled. |
Co-ordinatingContactDetail/CustomerDetail/PersonName |
CustomerDetails_r41 ClientInformation_r36 |
Co-ordinatingContactTelephoneNumber |
You can provide a maximum of three telephone numbers. Mandatory if ServiceOrderCo-ordinationRequired = Yes. Not relevant for Cancelled. |
Co-ordinatingContactDetail/CustomerDetail/AustralianPhoneNumber |
CustomerDetails_r41 ClientInformation_r36 |
CustomerConsultationRequired |
Yes = if the Recipient is requested to consult with the customer for the completion of work. If Yes, provide the reason for the need to consult in SpecialInstructions. No = no consultation arrangements required. Not relevant for Cancelled. |
xsd:Boolean |
Common_r41 |
CustomerContactName |
Mandatory if CustomerConsultationRequired = Yes. Not relevant for Cancelled. |
CustomerDetails_r41 ClientInformation_r36 |
|
CustomerContactTelephoneNumber |
You can provide a maximum of three telephone numbers. Mandatory if CustomerConsultationRequired = Yes Not relevant for Cancelled. |
CustomerDetails_r41 ClientInformation_r36 |
|
InitiatorContactName |
Not relevant for Cancelled. |
CustomerDetails_r41 ClientInformation_r36 |
|
InitiatorContactTelephoneNumber |
You can provide a maximum of three telephone numbers. Mandatory if CustomerContactName exists. Not relevant for Cancelled. |
CustomerDetails_r41 ClientInformation_r36 |
|
ScheduledDate |
Mandatory Not relevant for Cancelled. |
AppointmentDetail |
Common_r41 |
AppointmentReference |
Not relevant for Cancelled. |
AppointmentDetail/UniqueIdentifier |
Common_r41 |
CustomersPreferredDateAndTime |
Optional if an AppointmentReference is provided. Mandatory for Re-energisation if the ServiceOrderSubType is Retrospective Move-In. Not relevant for Cancelled. |
AppointmentDetail/AppointmentDateTime |
Common_r41 |
RP |
Mandatory for Supply Service Works Allocate NMI. Not relevant for Cancelled. |
RoleIdentifier |
Common_r41 |
MDP |
Mandatory for Supply Service Works Allocate NMI. Not relevant for Cancelled. |
RoleIdentifier |
Common_r41 |
MPB |
Mandatory for Supply Service Works Allocate NMI. Not relevant for Cancelled. |
RoleIdentifier |
Common_r41 |
NMIStatusCode |
Mandatory for: Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Optional for Miscellaneous. Not relevant for Cancelled. |
Common_r41 |
|
EmbeddedNetworkParentName |
Required for Supply Service Works Allocate NMI Not relevant for Cancelled. |
Electricity_r36 |
|
CustomerType |
Enumerated list. Mandatory for: Supply Service Works Allocate NMI Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Required for Metering Service Works Install Meter. Optional for Miscellaneous. Not relevant for Cancelled. |
CustomerType |
CustomerDetails_r41 |
AverageDailyLoad |
Mandatory for: Supply Service Works Allocate NMI Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Metering Service Works Install Meter Optional for Miscellaneous. Not relevant for Cancelled. |
Electricity_r36 |
|
MaximumDemand |
Required for: Supply Service Works Allocate NMI Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Supply Service Works Tariff Change Metering Service Works Install Meter Optional for Miscellaneous. Not relevant for Cancelled. |
Electricity_r36 |
|
REC-Name |
Mandatory for: Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Metering Service Works Install Meter Required for Supply Service Works Allocate NMI. Optional for Miscellaneous. Not relevant for Cancelled. |
CustomerDetails_r41 ClientInformation_r36 |
|
REC-BusinessName |
Mandatory for: Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Metering Service Works Install Meter Required for Supply Service Works Allocate NMI. Optional for Miscellaneous. Not relevant for Cancelled. |
CustomerDetails_r41 |
|
REC-Telephone |
You can provide a maximum of three telephone numbers. Mandatory for: Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Metering Service Works Install Meter Required for Supply Service Works Allocate NMI. Optional for Miscellaneous. Not relevant for Cancelled. |
CustomerDetails_r41 ClientInformation_r36 |
|
REC-ID |
Mandatory for: Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Metering Service Works Install Meter Required for Supply Service Works Allocate NMI. Optional for Miscellaneous. Not relevant for Cancelled. |
Electricity_r36 |
|
REC-AttendanceRequired |
Mandatory for: Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Metering Service Works Install Meter Required for Supply Service Works Allocate NMI. Optional for Miscellaneous. Not relevant for Cancelled. |
xsd:Boolean |
Common_r41 |
InstallationType |
Mandatory for: Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Required for Supply Service Works Allocate NMI. Optional for Miscellaneous. Not relevant for Cancelled. |
Electricity_r41 |
|
SupplyPhases |
Mandatory for: Supply Service Works Allocate NMI Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Metering Service Works Install Meter Metering Service Works Exchange Meter Optional for Miscellaneous. Not relevant for Cancelled. |
Electricity_r41 |
|
MeteringRequired |
Mandatory for: Metering Service Works Install Meter Metering Service Works Exchange Meter Optional for Miscellaneous. Not relevant for Cancelled. |
Electricity_r36 |
|
OffPeakRequirements |
Required for: Supply Service Works Allocate NMI Supply Service Works Establish T/TP/P Supply Service Works Supply Alteration Supply Service Works Tariff Change Metering Service Works Install Meter Metering Service Works Exchange Meter Optional for Miscellaneous. Not relevant for Cancelled. |
ServiceOrderRequestData/SpecialInstructions/SpecialComments |
Common_r41 |
MeterInstallCode |
Required for: Supply Service Works Tariff Change Metering Service Works Install Meter Metering Service Works Exchange Meter Optional for Miscellaneous. Not relevant for Cancelled. |
Electricity_r41 |
|
SwitchingServiceRequired |
Required for:
Optional for Miscellaneous. Not relevant for Cancelled. |
Electricity_r36 |
|
ProposedTariff |
Mandatory for:
Required for Metering Service Works Meter Reconfiguration Optional for Miscellaneous. Not relevant for Cancelled. |
NetworkBilling_r34 |
ServiceOrderResponse
Purpose |
Transaction Group |
Version |
Use |
---|---|---|---|
Submit Service Order completion details to the Retailer |
SORD |
r_36 |
optional |
Business field |
Restrictions |
aseXML |
Schema |
---|---|---|---|
ServiceOrderResponse |
ServiceOrderResponse |
ServiceOrder_r41 |
|
ResponseType |
Mandatory default = Closure |
ServiceOrder_r3641 |
|
ServiceOrderID |
Mandatory Must match the ServiceOrder ID in the ServiceOrderRequest. |
ServiceOrderHeader/ServiceOrderNumber/UniqueIdentifier |
ServiceOrder_r41 Common_r41 |
InitiatorID |
Mandatory |
/Header/From PartyIdentifier |
Common_r41 |
RecipientID |
Mandatory |
/Header/To PartyIdentifier |
Common_r41 |
NMI |
Mandatory for all responses except:
|
ServiceOrder/ServiceOrderHeader/NMI |
ServiceOrder_r41 Common_r41 |
NMIChecksum |
Optional |
ServiceOrder/ServiceOrderHeader/NMI/NMIChecksum |
ServiceOrder_r41 Common_36 |
ServiceOrderAddress |
Mandatory if the NMI is not provided in the Response. |
ServiceOrder/ServiceOrderHeader/Address |
ServiceOrder_r41 ClientInformation_r36 |
ServiceOrderStatus |
Mandatory |
ServiceOrder_r41 |
|
ExceptionCode |
Mandatory if ServiceOrderStatus = Not Completed or Partially Completed. |
Electricity_r36 |
|
ActualDateAndTime |
Mandatory |
xsd:dateTime (ccyy-mm-ddThh:mm:ss.sss+hh:mm) |
ServiceOrder_r41 |
SpecialNotes |
Mandatory if:
|
NotificationData/ServiceOrderNotificationData/SpecialNotes/SpecialComments /CommentLine |
ServiceOrder_r41 Common_r41 |
RecipientContactName |
Optional |
ContactDetail/CustomerDetail/PersonName The ContactDetail is derived from the customerNotificationMethod |
CustomerDetails_r41 ClientInformation_r36 |
RecipientContactTelephoneNumber |
Optional |
ContactDetail/CustomerDetail/AustralianPhoneNumber The ContactDetail is derived from the customerNotificationMethod |
CustomerDetails_r41 ClientInformation_r36 |
RecipientReference |
Required Not necessarily unique |
AppointmentDetail/UniqueIdentifier |
Common_r41 |
ProductCode |
Mandatory |
CustomerDetails_r41 |
SO BusinessAcceptance/Rejection
Business field |
Restrictions |
aseXML |
Schema |
|||
---|---|---|---|---|---|---|
EventCode |
Mandatory See B2B Procedure: Service Order Process |
Events_r41 |
||||
KeyInfo |
Optional or Not relevant If populated with a number, it is the number within the NotificationDetail where the event occurred. If the field is not populated, it refers to the aseXML transaction, not a specific line within the data. |
Events_r41 |
||||
Context |
Optional If KeyInfo is populated, this is a copy of the line where the event was found. If the line is longer than the field size, fully populate starting from the first character of the line. |
Events_r41 |
||||
Explanation |
Mandatory if the Business Event requires an explanation, otherwise optional xsd:string unlimited chars, minOccurs=”0” See B2B Procedure: One Way Notification Process |
Explanation |
Events_r41 |