Supports Exchanges

Create a support exchange

POSThttps://api.dashdoc.eu/api/v4/supports-exchanges/

Body

site*NewSupportsExchange_site (object)

uid of the site where supports exchange is expected

support_type*NewSupportsExchange_support_type (object)

Type of the supports that are exchanged

expected_retrievednumber

Expected number of supports that should be retrieved on the site

Example: 10

actual_retrievednumber

Actual number of supports that were retrieved on the site

Example: 0

expected_deliverednumber

Expected number of supports that should be delivered on the site

Example: 10

actual_deliverednumber

Actual number of supports that were delivered on the site

Example: 0

observationsstring

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

Example: "1 broken"

Response

Create successful

Body

uidstring (uuid)

uid of the support exchange

siteSupportsExchange_site (object)

site where supports exchange is expected

support_typeSupportType (object)

Type of the supports that are exchanged

expected_retrievednumber

Expected number of supports that should be retrieved on the site

Example: 10

actual_retrievednumber

Actual number of supports that were retrieved on the site

Example: 10

expected_deliverednumber

Expected number of supports that should be delivered on the site

Example: 10

actual_deliverednumber

Actual number of supports that were delivered on the site

Example: 10

observationsstring

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

Example: "1 broken"

remote_idstring

The ID of the support in your system

Request

const response = await fetch('https://api.dashdoc.eu/api/v4/supports-exchanges/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "site": {},
      "support_type": {}
    }),
});
const data = await response.json();

Response

{
  "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

GEThttps://api.dashdoc.eu/api/v4/supports-exchanges/{uid}/

Path parameters

uid*string

remote_idstring

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

Response

Get successful

Body

uidstring (uuid)

uid of the support exchange

siteSupportsExchange_site (object)

site where supports exchange is expected

support_typeSupportType (object)

Type of the supports that are exchanged

expected_retrievednumber

Expected number of supports that should be retrieved on the site

Example: 10

actual_retrievednumber

Actual number of supports that were retrieved on the site

Example: 10

expected_deliverednumber

Expected number of supports that should be delivered on the site

Example: 10

actual_deliverednumber

Actual number of supports that were delivered on the site

Example: 10

observationsstring

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

Example: "1 broken"

remote_idstring

The ID of the support in your system

Request

const response = await fetch('https://api.dashdoc.eu/api/v4/supports-exchanges/{uid}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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

PATCHhttps://api.dashdoc.eu/api/v4/supports-exchanges/{uid}/

Path parameters

uid*string

Body

site*NewSupportsExchange_site (object)

uid of the site where supports exchange is expected

support_type*NewSupportsExchange_support_type (object)

Type of the supports that are exchanged

expected_retrievednumber

Expected number of supports that should be retrieved on the site

Example: 10

actual_retrievednumber

Actual number of supports that were retrieved on the site

Example: 10

expected_deliverednumber

Expected number of supports that should be delivered on the site

Example: 10

actual_deliverednumber

Actual number of supports that were delivered on the site

Example: 10

observationsstring

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

Example: "1 broken"

Response

Update successful

Body

uidstring (uuid)

uid of the support exchange

siteSupportsExchange_site (object)

site where supports exchange is expected

support_typeSupportType (object)

Type of the supports that are exchanged

expected_retrievednumber

Expected number of supports that should be retrieved on the site

Example: 10

actual_retrievednumber

Actual number of supports that were retrieved on the site

Example: 10

expected_deliverednumber

Expected number of supports that should be delivered on the site

Example: 10

actual_deliverednumber

Actual number of supports that were delivered on the site

Example: 10

observationsstring

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

Example: "1 broken"

remote_idstring

The ID of the support in your system

Request

const response = await fetch('https://api.dashdoc.eu/api/v4/supports-exchanges/{uid}/', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "site": {},
      "support_type": {}
    }),
});
const data = await response.json();

Response

{
  "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"
}

PreviousSupport Types NextTelematics

Last updated 11 months ago

const response = await fetch('https://api.dashdoc.eu/api/v4/supports-exchanges/', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "site": {}, "support_type": {} }), }); const data = await response.json();

{ "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" }

const response = await fetch('https://api.dashdoc.eu/api/v4/supports-exchanges/{uid}/', { method: 'PATCH', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "site": {}, "support_type": {} }), }); const data = await response.json();