Introduction Requirements Change Requests | OGC

Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6 197 Copyright © 2012 Open Geospatial Consortium 16 Cancel Operation

16.1 Introduction

This operation allows cancelling a previously submitted order. In case of EO product orders this operation triggers the cancellation of the order items; in case of subscriptions it means to unsubscribe from them. The cancellation of product order items is not always possible, and then the operation returns the following results: – “success”, if all items can be cancelled; – “incomplete”, in case of partial cancellation The cancellation is not a real-time process, and then the operation is asynchronous.

16.2 Requirements

Req. id Requirement URI Requirement Class Requirement Text Req 113 http:www.opengis.netsp ecOSEO1.0reqCancella tionCancel Cancellation The Order Server shall implement the Cancel operation. Req 114 http:www.opengis.netsp ecOSEO1.0reqCancella tionCancelreqschema Cancellation The Cancel request shall consist of an XML instance document validated by the entity Cancel in the oseo.xsd XML Schema. Req 115 http:www.opengis.netsp ecOSEO1.0reqCancella tionCancelreqsync Cancellation The Order Server shall accept cancellation requests including: ฀ The identifier of the order to be cancelled: CancelorderId ฀ No notification: CancelstatusNotification = None Req 116 http:www.opengis.netsp ecOSEO1.0reqCancella tionCancelack_schema Cancellation The message output generated by the Cancel request shall consist of an XML instance document validated by the entity CancelAck in the oseo.xsd XML Schema. Req 117 http:www.opengis.netsp ecOSEO1.0reqCancella tionCancelack Cancellation The response to a successful Cancel shall include: CancelAckstatus = success Req 118 http:www.opengis.netsp ecOSEO1.0reqCancella tionCancelfunction Cancellation On successful acceptance of the Cancel request, the Order Server shall start the cancellation of the specified order. Comment: For verifying whether the Order Server is actually cancelling the order the GetStatus operation can be used. Req 119 http:www.opengis.netsp ecOSEO1.0reqCancella tionCancelexception Cancellation When a Order Server encounters an error while performing a Cancel operation, it shall return an ows: ExceptionReport according to the clause 8 of [NR9]. Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6 198 Copyright © 2012 Open Geospatial Consortium Req. id Requirement URI Requirement Class Requirement Text Req 120 http:www.opengis.netsp ecOSEO1.0reqAsyncC ancellationCancelFinal AsyncCancellat ion The Order Server shall accept cancellation requests including: ฀ The identifier of the order to be cancelled: CancelorderId ฀ Notification at cancellation completion: SubmitstatusNotification = Final soapenv:Envelopesoapenv:Headerwsa:ReplyTo Req 121 http:www.opengis.netsp ecOSEO1.0reqAsyncC ancellationCancelAll AsyncCancellat ion The Order Server shall accept cancellation requests including: ฀ The identifier of the order to be cancelled: CancelorderId ฀ All notifications: SubmitstatusNotification = All soapenv:Envelopesoapenv:Headerwsa:ReplyTo Req 122 http:www.opengis.netsp ecOSEO1.0reqAsyncC ancellationCancelRespon seschema AsyncCancellat ion The asynchronous notification CancelResponse to a successful Cancel request shall consist of an XML instance document as validated by the entity CancelResponse in the oseo.xsd XML Schema. Req 123 http:www.opengis.netsp ecOSEO1.0reqAsyncC ancellationCancelRespon sefinal AsyncCancellat ion Ths asynchronous notification CancelResponse to a Cancel request with: CancelstatusNotification = Final shall be sent by the Order Server only once at cancellation completion. Req 124 http:www.opengis.netsp ecOSEO1.0reqAsyncC ancellationCancelRespon seall AsyncCancellat ion Ths asynchronous notification CancelResponse to a Cancel request having: CancelstatusNotification = All shall be sent by the Order Server whenever the status of at least one item in the order is changed. Req 125 http:www.opengis.netsp ecOSEO1.0reqAsyncC ancellationCancelRespon seresp AsyncCancellat ion The asynchronous notification CancelResponse to a successful Submit request shall contain: ฀ The order date and time: SubmitResponsetimeStamp ฀ Overal order status info ฀ One status info for each ordered item: SubmitResponseorderMonitorSpecificationorderItem Req 126 http:www.opengis.netsp ecOSEO1.0reqAsyncC ancellationCancelRespon seack_schema AsyncCancellat ion The message output generated by the CancelResponse request shall consist of an XML instance document validated by the entity CancelResponseAck in the oseo.xsd XML Schema. The Order Server shall accept the CancelResponseAck. Table 16-1: Cancel requirements. Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6 199 Copyright © 2012 Open Geospatial Consortium

16.3 Cancel operation request