GET api/order/Service/{OrderServiceID}/EndPointProperties

This API method returns a list endpoint properties associated with an order service. Note this will only return the properties for the endpoiunt currently selected on the order service.

Error Messages
  • 500/Internal Server Error - Error retrieving order service record with id x
  • 404/Not Found - No order service found with id x - Specified ID does not match an existing Order Services.
  • 403/Forbidden - The OrderServiceID x is not a service that supports endpoints - The service assigned to this order does not support endpoints. Select one that does to assign an Endpoint to this order.
  • 403/Forbidden - The OrderServiceID x requires a valid EndPoint to be set for propertyID y.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderServiceID ID number of the order service integer

Required

Body Parameters

None.

Response Information

Resource Description

List of ViewEndPointProperty

EndPointPropertyView
NameDescriptionTypeAdditional information
EndPointID EndpointID integer

None.

PropertyID Inventory PropertyID integer

None.

ControlID GUID for Control string

None.

ControlType Control Type integer

None.

AcceptedValues Dictionary of string [key] and string [value]

None.

RegExValidation Regular Expression validation rule string

None.

RegExValidationText Text to be displayed if value fails rule string

None.

Mandatory Denotes whether the End Point properties are mandatory boolean

None.

Editable Denotes whether the End Point properties are editable boolean

None.

LabelName Display name for control string

None.

DefaultValue Default value string

None.

CurrentValue Value of property as is appears in the order service string

None.

LocationX Screen location - horizonal integer

None.

LocationY Screen location - vertical integer

None.