Skip to content

Commit

Permalink
add a response example
Browse files Browse the repository at this point in the history
  • Loading branch information
kshychko committed Apr 26, 2017
1 parent e9875f4 commit 528569c
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions docs/2.0/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,20 @@ The `signature` part is created by a business system component trusted by the se

Receiving TAPs may also use the signature as a filter (messages with invalid signatures MAY be dropped by receiving TAPs, rather than delivered). This allows TAPs to buffer trusted components from anonymous denial of service attacks.

When a valid message is received, the TAP issues an HTTP 200 status and returns a response body with `Content-Type: text/json`, containing a HATEOS-style list of callback URLs.
When a valid message is received, the TAP issues an HTTP 200 status and returns a response body with `Content-Type: application/json`, containing a HATEOS-style list of callback URLs.

![Illustration of HTTP 200 response](./tap_overview_response.png "Response 200 OK")
```
{
"data": {
"type": "TapMessage",
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXX",
"attributes": {
"uuid": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXX",
"status": "in_transit"
}
}
}
```

See the TAP Protocol Details chapter for more information.

Expand Down Expand Up @@ -336,14 +347,13 @@ curl -X POST \

## Receipt and Technical Acknowledgement

When a valid message is received, the TAP issues an HTTP 200 status and returns a response body with `Content-Type: text/json`, containing a HATEOS-style list of callback URLs.
When a valid message is received, the TAP issues an HTTP 200 status and returns a response body with `Content-Type: application/json`, containing a HATEOS-style list of callback URLs.
Check the [API](http://ausdigital.org/specs/ausdigital-tap/2.0/api) for possible error response.

TODO:

* example response.
* explain callback URLs
* explain callback semantic URLs
* define error responses.


# Related Material
Expand Down

0 comments on commit 528569c

Please sign in to comment.