GET AdditionalServices by id

Overview

Retrieve additional service by ID

Request

GET /AdditionalServices/[id]

Request Information

Request Parameters

Name
Type
Requirement
Description
id
Integer
Mandatory 
ID of the additional service

Response Information

Response Properties

Name
Type
Description
product
HrefWrapper
URI of additional service product
additionalServiceName
String
Name of additional service product
currency
String
Currency
totalPrice
Decimal
Total gross price for all customers on additional service
netPrice
Decimal
Gross price minus any commission for the additional service
startDate
String
Start date for additional service
endDate
String
End date for additional service
customers
HrefWrapper
URI used to retrieve all customers on additional services
customerStatuses
Key Value Pair
Key/value pairs indicating the number of customers 
per status on the additional service; e.g.: 
{
''confirmed'': 2,
''cancelled'': 1
}
customerStatusIds
List<CustomerStatuses>
List of customer statuses along with url for each customer on that status
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Product

Name
Type
Description
href
String
URI of the resource

Customers

Name
Type
Description
href
String
URI of the resource

Customerstatusids

Name
Type
Description
status
String
Customers status
customers
List<HrefWrapper>
Url of Customers in relevant status

Response Codes

HTTP status code
Description
200 OK
The resource was retrieved successfully
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server

Response Example

{
  "product": {
    "href": "/products/91066"
  },
  "additionalServiceName": "Camping Sleeping bag hire",
  "currency": "AUD",
  "totalPrice": 125.0,
  "netPrice": 120.5,
  "startDate": "2016-12-15",
  "endDate": "2016-12-20",
  "customers": {
    "href": "/additionalservices/887124/customers"
  },
  "customerStatuses": {
    "confirmed": 2,
    "tentative": 1
  },
  "customerStatusIds": [
    {
      "status": "tentative",
      "customers": [
        {
          "href": "/context/5057124/customers/4945398"
        },
        {
          "href": "/context/5057124/customers/4945398"
        }
      ]
    },
    {
      "status": "tentative",
      "customers": [
        {
          "href": "/context/5057124/customers/4945398"
        },
        {
          "href": "/context/5057124/customers/4945398"
        }
      ]
    }
  ],
  "id": 887124,
  "href": "additionalservices/887124",
  "sequence": "202403312359580000"
}