Product reservation sources

You can get the list of the available product reservation sources here.

Available methods

All available methods for resource product reservation sources.

HTTP method Endpoint Description
[badge-blue GET] /product-reservation-sources Get information about all product reservation sources
[badge-blue GET] /product-reservation-sources/{product_reservation_sources_id} Get information about specific product reservation source

Get all product reservation sources

Get a list of product reservation sources accepted in CRM CareCloud
[badge-blue GET ] /product-reservation-sources

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
product_reservation_sources ProductReservationSource[] List of the product reservation sources
total_items integer Count of all found product reservation sources

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0//product-reservation-sources
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NDmEyZjc1NDI3YWUwMTM0NmMyOWQxNmE4NzI1MWZlzZmMzcwNmI2MDJmDfN2Q2Mw==

Example response

HTTP/1.1 200 OK
Date: Tue, 20 Oct 2020 13:16:16 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "product_reservation_sources": [
      {
        "product_reservation_source_id": "86e05affc7a7abefcd513ab400",
        "name": "Web",
        "last_change": "2020-09-09 12:32:42.143353",
        "state": 1
      },
      {
        "product_reservation_source_id": "8bed991c68a470e7aaeffbf048",
        "name": "E-shop",
        "last_change": "2020-09-09 12:32:42.143353",
        "state": 1
      },
      {
        "product_reservation_source_id": "81eaeea13b8984a169c490a325",
        "name": "Mobile application",
        "last_change": "2020-09-09 12:32:42.143353",
        "state": 1
      }
    ],
    "total_items": 3
  }
}


Detail of an product reservation source

Get information about a specific product reservation source
[badge-blue GET] /product-reservation-sources/{product_reservation_source_id}

Path parameters

Parameter name Type Description
product_reservation_source_id string The unique id of an product reservation source in CareCloud

Response

Status code: 200 OK
Output structure : ProductReservationSource

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/product-reservation-sources/8bed991c68a470e7aaeffbf048
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NDJhMDAxNmEyZjc1NDI3YWUwMTM0NmMyOWQxNmE4NzI1MWZlzZmMzcwNmI2MDJmDfN2Q2Mw==

Example response

HTTP/1.1 200 OK
Date: Tue, 20 Oct 2020 13:17:45 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "product_reservation_source_id": "8bed991c68a470e7aaeffbf048",
    "name": "E-shop",
    "last_change": "2020-09-09 12:32:42.143353",
    "state": 1
  }
}