Returns
Delete Open Return Template – REST
Summary
| Name: | Delete Open Return Template |
|---|---|
| Reason to Call: | To delete an existing open return template. |
| Input: | None – the endpoint href is a direct link to invoke this service for a specific template. |
| Output: | None |
| Typical Next Call: | Create Open Return Template |
| Version history: | Release notes |
Delete Open Return Template – Summary of Service
Request Details
Request – Structure for Delete Open Return Template
Endpoint
Invoke the link returned from a prior call to Create Open Return Template or Get Open Return Template where the value of the attribute “rel” is “self”.
HTTP Headers
HTTP Header Variable |
Value |
|---|---|
Accept |
application/vnd.cpc.openreturn+xml (Note: */* in place of the header value will return an error) |
Content-Type |
application/vnd.cpc.openreturn+xml (Note: */* in place of the header value will return an error) |
Authorization |
Basic {Base64 encoding of userid:password} |
Accept-language |
en-CA or fr-CA |
Body
None
Request – Elements
Delete Open Return Template does not require any input XML data.
Response Details
The Delete Open Return Template service does not respond with any XML data.
Response – Possible Error Responses
In the case of an application error, an HTTP 400 level status code error response will be generated and the XML body will have an error message structure rather than the success response. For more information, see HTTP status codes.
Possible error messages for this service include the following:
| HTTP Status Code | Application Error | Message |
|---|---|---|
| 500 | N/A | Detailed schema validation error is provided. |
| 412 | 9999 |
Examples
Sample REST XML Request – Delete Open Return Template
DELETE https://XX/PROVIDED LINK
Accept:application/vnd.cpc.openreturn+xml
Authorization:Basic s7HD7gwsennesc==
Note: Do not hard-code the HTTP endpoint link. The link is provided as an output from Create Open Return Template or Get Open Return Template.
Sample REST XML Response – Delete Open Return Template
The Delete Open Return Template does not respond with any XML elements (unless an error occurs in which case the standard error response is provided).
