Skip to content
/Order Status

Order Status

Webhooks

Notify Of Order Status
Webhook

Request

Messages sent back to the ALA user to indicate progress of an order.

To facilitate correct construction of messages, these messages will either contain an alaOrderInProgress message if the order is in progress, alaOrderFailed if the order has failed or cancelled and alaOrderCompleted if the order has completed.

Bodyapplication/xml
One of:
messageobject(message)required

The meta-data of the request. It includes information regarding the message UUID, transaction ID and the sent timestamp

buyerobject(buyer)required

The Service Provider who consumes the service is the buyer

sellerobject(seller)required

the Active Network Operator who provides the service is the seller

orderReferencesobject(newOrderReferences)required

Reference for the order for this buyer

issuedAtstring, (date-time)(issuedAt)required

The timestamp when the order status notification has been issued at

Example:"2012-01-20T18:30:43Z"
sequenceNumbernumber(sequenceNumber)required
Example:1
alaOrderStatusPending (object) or Acknowledged (object) or Committed (object)required
One of:
alaOrderInProgressobject or alaOrderInProgress with Case (object) or alaOrderInProgress general (object)(alaOrderInProgress)required
One of:
object
notesArray of objects(notes)
Payload
<notifyOfOrderStatus xmlns="http://www.niccstandards.org.uk/ala_1.0.xsd" xmlns:cfh="http://www.cityfibre.com/ala/ext1">
  <message>
    <messageId>b68b2cf4-475e-11e1-a92e-fb2ff6467c99</messageId>
    <correlationId>bac72cfa-475e-11e1-a92e-fb2ff6467c99</correlationId>
    <sentAt>2012-01-20T18:30:43Z</sentAt>
  </message>
  <buyer>
    <buyerIdentifier>SPDEV1</buyerIdentifier>
  </buyer>
  <seller>
    <sellerIdentifier>CITYFIBRE</sellerIdentifier>
  </seller>
  <orderReferences>
    <buyerOrderReference>CST1234567</buyerOrderReference>
    <sellerOrderReference>CFH123456543</sellerOrderReference>
  </orderReferences>
  <issuedAt>2012-01-20T18:30:43Z</issuedAt>
  <sequenceNumber>0</sequenceNumber>
  <alaOrderStatus>
    <pending/>
  </alaOrderStatus>
  <alaOrderInProgress />
  <notes>
    <note>No Toby to property</note>
  </notes>
</notifyOfOrderStatus>

Responses

Acknowledgement of the message.

Bodyapplication/xml
notifyOfOrderStatusResponsenull
Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <notifyOfOrderStatusResponse xmlns="http://www.niccstandards.org.uk/ala_1.0.xsd" />
  </soap:Body>
</soap:Envelope>