# Retrieve current service test details including result if available.

This endpoint is called to retrieve the current details and status for a service test request. The result of
the test will be returned if available.

Endpoint: GET /service-tests/{id}
Version: 1.17
Security: oauth2

## Header parameters:

  - `X-Request-ID` (string, required)
    Unique identifier to identify request and response events across the Fibre Cafe gateway

  - `X-Conversation-ID` (string, required)
    Identifier to track message journey across the Fibre Cafe gateway

## Path parameters:

  - `id` (string, required)
    Find service test details relating to the specified identifier

## Response 200 fields (application/json):

  - `id` (number, required)
    Unique reference identifying this service test (test number - generated by Fibre Cafe)
    Example: 123

  - `status` (string, required)
    Service test lifecycle adapted from TMF653 - update events (KCIs) will be sent to the tenant as the test transitions from one state to the other.
    Enum: "RECEIVED_BY_GATEWAY", "SENT_TO_SUPPLIER", "FAILED_TO_SEND", "REJECTED", "IN_PROGRESS", "FAILED", "COMPLETED"

  - `created` (string)
    Date/time when the service test was created
    Example: "2022-01-01T09:09:33.001Z"

  - `updated` (string)
    Date/time when the service test was last updated
    Example: "2022-01-01T09:45:39.001Z"

  - `supplierReference` (string)
    Supplier reference for this service test (if available - for information only)
    Example: "A12345"

  - `serviceId` (string, required)
    Identifier of an existing live service
    Example: "SI2345432345345"

  - `problemType` (string, required)
    The type of problem being experienced with the service.
- CPE
- CUSTOMER
- OUTAGE
- PERFORMANCE
- STABILITY
- SYNCHRONISATION

  - `serviceSpecification` (object, required)
    Details of a service the supplier provides at the selected address.

  - `serviceSpecification.id` (string, required)
    Unique identifier for this service specification
    Example: "ftthl2r"

  - `serviceSpecification.name` (string)
    Name of the service
    Example: "FTTH"

  - `supplier` (string, required)
    System identifier for a supplier on the Fibre Cafe that is associated with this service
    Example: "DUMMY_SUPPLIER"

  - `characteristics` (array, required)

  - `characteristics.name` (string, required)
    Name of the characteristic

  - `characteristics.value` (string, required)
    Value for this characteristic

  - `result` (object)
    Result of a service test request once available.

  - `result.testValidity` (string, required)
    The time until the test results are no longer valid. If test is invalid, it is set to now
    Example: "2022-01-01T09:45:39.001Z"

  - `result.testMeasures` (array)
    The specific metrics returned as part of the service test execution (where available)

  - `result.testMeasures.metricName` (string, required)
    The name of the metric being reported
    Example: "ONT_LIGHT_LEVEL"

  - `result.testMeasures.captureDateTime` (string)
    The date-time the measurement was captured
    Example: "2022-01-01T09:45:39.001Z"

  - `result.testMeasures.metricValue` (string, required)
    A measurement of the metric
    Example: "-14.5"

  - `result.testMeasures.unitOfMeasure` (string)
    A unit of measurement used to measure the metric
    Example: "decibel"

  - `result.testMeasures.ruleViolation` (boolean)
    Confirms if the measurement is below the agreed thresholds and a rule violation has occurred

  - `result.testMeasures.ruleSeverity` (string)
    The severity of the violation
    Enum: "SEVERE", "MAJOR", "MINOR", "WARNING", "N/A"

  - `result.testOutcome` (object, required)
    The outcome of the service test execution.

  - `result.testOutcome.testResult` (string, required)
    RAG Status on the service test execution
    Enum: "UNAVAILABLE", "RED", "AMBER", "GREEN", "FAILED"

  - `result.testOutcome.code` (string, required)
    Code representing the test result
    Example: "NO_FAULT_FOUND"

  - `result.testOutcome.description` (string)
    A textual description of the service test and associated next steps

  - `result.testOutcome.supplierCodes` (array)
    Supplier code(s) representing the test result
    Example: ["D1234"]

  - `result.testOutcome.supplierText` (string)
    Text from the supplier explaining the test result (where available)

## Response 400 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 401 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 404 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 422 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 500 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]


## Response 403 fields

## Response 503 fields