Supports Exchanges

Create a support exchange

post

Authorizations

ApiKeyAuth

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Body

application/json

expected_retrievednumberOptional

Expected number of supports that should be retrieved on the site

Example: 10

actual_retrievednumberOptional

Actual number of supports that were retrieved on the site

Example: 0

expected_deliverednumberOptional

Expected number of supports that should be delivered on the site

Example: 10

actual_deliverednumberOptional

Actual number of supports that were delivered on the site

Example: 0

observationsstringOptional

Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.

Example: 1 broken

Responses

201

Create successful

application/json

uidstring · uuidOptional

uid of the support exchange

expected_retrievednumberOptional

Expected number of supports that should be retrieved on the site

Example: 10

actual_retrievednumberOptional

Actual number of supports that were retrieved on the site

Example: 10

expected_deliverednumberOptional

Expected number of supports that should be delivered on the site

Example: 10

actual_deliverednumberOptional

Actual number of supports that were delivered on the site

Example: 10

observationsstringOptional

Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.

Example: 1 broken

remote_idstringOptional

The ID of the support in your system

post/supports-exchanges/

HTTPcURLJavaScriptPython

POST /api/v4/supports-exchanges/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "site": {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "remote_id": "text"
  },
  "support_type": {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "remote_id": "text"
  },
  "expected_retrieved": 10,
  "actual_retrieved": 0,
  "expected_delivered": 10,
  "actual_delivered": 0,
  "observations": "1 broken"
}

201

Create successful

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "site": {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "remote_id": "text"
  },
  "support_type": {
    "name": "Palettes",
    "created": "2020-12-22T15:31:39.26167Z",
    "uid": "c8e4cc62-446a-11eb-a759-0242ac130005",
    "remote_id": "text"
  },
  "expected_retrieved": 10,
  "actual_retrieved": 10,
  "expected_delivered": 10,
  "actual_delivered": 10,
  "observations": "1 broken",
  "remote_id": "text"
}

Read a support exchange

get

Authorizations

ApiKeyAuth

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Path parameters

uidstringRequired

remote_idstringOptional

If you choose to identify an object with its remote_id instead of its uid then

• replace the uid value with the remote_id value in the URL

• specify lookup_field=remote_id in the query parameters

Query parameters

lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Responses

200

Get successful

application/json

uidstring · uuidOptional

uid of the support exchange

expected_retrievednumberOptional

Expected number of supports that should be retrieved on the site

Example: 10

actual_retrievednumberOptional

Actual number of supports that were retrieved on the site

Example: 10

expected_deliverednumberOptional

Expected number of supports that should be delivered on the site

Example: 10

actual_deliverednumberOptional

Actual number of supports that were delivered on the site

Example: 10

observationsstringOptional

Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.

Example: 1 broken

remote_idstringOptional

The ID of the support in your system

get/supports-exchanges/{uid}/

HTTPcURLJavaScriptPython

GET /api/v4/supports-exchanges/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*

200

Get successful

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "site": {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "remote_id": "text"
  },
  "support_type": {
    "name": "Palettes",
    "created": "2020-12-22T15:31:39.26167Z",
    "uid": "c8e4cc62-446a-11eb-a759-0242ac130005",
    "remote_id": "text"
  },
  "expected_retrieved": 10,
  "actual_retrieved": 10,
  "expected_delivered": 10,
  "actual_delivered": 10,
  "observations": "1 broken",
  "remote_id": "text"
}

Partially update a support exchange

patch

Authorizations

ApiKeyAuth

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Path parameters

uidstringRequired

Body

application/json

expected_retrievednumberOptional

Expected number of supports that should be retrieved on the site

Example: 10

actual_retrievednumberOptional

Actual number of supports that were retrieved on the site

Example: 10

expected_deliverednumberOptional

Expected number of supports that should be delivered on the site

Example: 10

actual_deliverednumberOptional

Actual number of supports that were delivered on the site

Example: 10

observationsstringOptional

Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.

Example: 1 broken

Responses

200

Update successful

application/json

uidstring · uuidOptional

uid of the support exchange

expected_retrievednumberOptional

Expected number of supports that should be retrieved on the site

Example: 10

actual_retrievednumberOptional

Actual number of supports that were retrieved on the site

Example: 10

expected_deliverednumberOptional

Expected number of supports that should be delivered on the site

Example: 10

actual_deliverednumberOptional

Actual number of supports that were delivered on the site

Example: 10

observationsstringOptional

Free text. Observations about this supports exchange. Can be filled on mobile app, web app or via API.

Example: 1 broken

remote_idstringOptional

The ID of the support in your system

patch/supports-exchanges/{uid}/

HTTPcURLJavaScriptPython

PATCH /api/v4/supports-exchanges/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "site": {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "remote_id": "text"
  },
  "support_type": {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "remote_id": "text"
  },
  "expected_retrieved": 10,
  "actual_retrieved": 10,
  "expected_delivered": 10,
  "actual_delivered": 10,
  "observations": "1 broken"
}

200

Update successful

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "site": {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "remote_id": "text"
  },
  "support_type": {
    "name": "Palettes",
    "created": "2020-12-22T15:31:39.26167Z",
    "uid": "c8e4cc62-446a-11eb-a759-0242ac130005",
    "remote_id": "text"
  },
  "expected_retrieved": 10,
  "actual_retrieved": 10,
  "expected_delivered": 10,
  "actual_delivered": 10,
  "observations": "1 broken",
  "remote_id": "text"
}