# Create a service test record for an active service.

This endpoint can be called to perform a service test on an active service.

The Fibre Cafe will validate the request and generate a service test identifier which is
returned. If the test request is rejected immediately then a 4XX code will be returned
with reason(s) for the rejection in the response.

The Fibre Cafe will internally determine the best supplier test to execute based on supplier 
and service specification attributes, in addition to the PROBLEM_TYPE characteristics supplied.

The service test result will be returned asynchronously via a KCI, and may also be queried via
the GET /service-tests/{id} API.

Endpoint: POST /service-tests
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

## Request fields (application/json):

  - `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"

  - `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

## Response 201 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

## 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 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