Meeting+ API

The AskCody Meeting+ API is accessed using the base URL https://api.onaskcody.com/meeting

All data is in JSON format using the application/json Media Type.

In order to access the API, you need to specify an API key and an API version using HTTP headers:

Header
Example Value
X-AskCody-API-Key

qRniOJFwlcWC-_16pdSFVtH-I5BgPTvhLBxkoREWNOHRaQbILNIrX_MyvquSZo5V

X-AskCody-API-Version 1

Available endpoints

The Meeting+ API currently has three endpoints:

Name
Description
Method
Path
Parameters
Unsettled Deliveries Returns a list of unsettled deliveries. GET /deliveries/unsettled

startTime: Only return deliveries delivered after this time. Optional.

endTime: Only return deliveries delivered before this time. Optional.

Delivery

Returns the delivery with the given ID.

GET /deliveries/<id> None
Settle Delivery Settles the delivery with the given ID. POST /deliveries/<id>/settle externalId: External ID to associate with the delivery. Optional.

 

Parameter formats

All "id" parameters are integers / whole numbers. 

The parameters "startTime" and "endTime" are DateTime formats, and should follow the ISO8601 standard. The following formats are valid:

2019-02-22T10:05:04+00:00
2019-02-22T10:05:04Z
20190222T100504Z

 

Caution: Sending a GET request requires the data to be URL encoded, because characters like "+" are not supported, and will be filtered away - if this happens the response will simply be empty, but the request will be allowed.

 

Additionally the time can be omitted from the parameter, so you only specify the date:

2019-02-22

 

Caution: Only specifying the Date is implicitly adds 00:00:00 as the time format, so if you try to get a single days deliveries, for example Februrary 22nd us the following format:

startTime: 2019-02-22
endTime: 2019-02-23

Request examples

https://api.onaskcody.com/meeting/deliveries/unsettled?startTime=2019-02-14T08:00:00%2B0000&endTime=2019-02-14T11:00:00%2B0000

https://api.onaskcody.com/meeting/deliveries/unsettled?startTime=2019-02-14T08:00:00Z&endTime=2019-02-14T11:00:00Z

https://api.onaskcody.com/meeting/deliveries/unsettled?startTime=2019-02-14&endTime=2019-02-15

Running a sample request in Postman

Postman can be a great tool for testing API requests. A simple GET request could be done as below

 

Response data format

A sample delivery in JSON format looks like this:

Delivery JSON
{
  "id": 1,
  "deliverAt""1970-01-01T00:00:00+0000",
  "costCenter""1234",
  "totalPrice""EUR 100.00",
  "status""completed",
  "externalId"null,
  "settledAt"null,
  "settledBy"null,
  "externalParticipants""",
  "extensionAttributes": {
    "additionalCostCenter""DK421337",
    "internalAttendees""1",
    "externalAttendees""0"
  },
  "meeting": {
    "id""BAAAAIIA4AB0xbcQGoLgCAAAAABO8nVvNd7PAQAAAAAAAAAAEAAAAHdxiGFkA01Dl0brT6qlhE4=",
    "startTime""2016-05-31T13:00:00+0000",
    "endTime""2016-05-31T14:00:00+0000",
    "subject""Test meeting for API",
    "organizerName""Filip S. Adamsen",
    "organizerAddress""fsa@askcody.dk",
    "location""Development"
  },
  "orderer": {
    "name""Filip S. Adamsen",
    "email""fsa@askcody.dk",
    "attributes": [
      "location""Aalborg",
      "personalCostCenter""DK133742"
    ]
  }
}

Postman collection

Attached are examples available as a Postman collection.

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.