GET api/order/Service/{OrderServiceID}

This API method returns an order service for a given Order Service ID, this includes a sub-list of service properties.

Notes:

  • In the property list, if the Editable field is set to true the value will not be editable.
  • If you are an Agent or Reseller the returned properties will be limited to the said customer type.

The API method will only return information for the following control types:

  • Textbox
  • Dropdown
  • Checkbox
  • Multiline Checkbox.
Error Messages
  • 500/Internal Server Error - Error getting order service record with id x
  • 404/NotFound - Order Service not found with id x - No Order Service is assigned to the specified Order Service.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderServiceID ID of order service integer

Required

Body Parameters

None.

Response Information

Resource Description

List of OrderServicesView

OrderServiceView
NameDescriptionTypeAdditional information
OrderServiceID Order ID integer

None.

InventoryID Template ID of ther service integer

None.

OrderID ID number of quote or order integer

None.

SiteID Site the service will be depolyed to integer

None.

RequestedDate Date the order was created date

None.

Quantity Number ordered integer

None.

ServiceGroup Group name (if any) string

None.

ServiceName Service Name string

None.

ServiceStatus Provisioning Status string

None.

StartDate Provisioning date date

None.

Properties List of properties attached to a service Collection of OrderServicePropertyView

None.