Skip to main content

Comfort Partners

Overview​

This page provides details of requirements of comfort partners and endpoint details

Requirements​

  • Identity validation in CAIC based on postal code and house number and in case of an appointment a WCP number.
  • Their clients being able to see their appointment, to change their appointment or to cancel their appointment in a conversation within CAIC (WhatsApp and Webconversations).
  • When a customer does reach out to them and a handover takes place towards MSC (Channel: WhatsApp and Webconversation), they also want to see the appointments made.

Authentication​

To invoke the endpoint https://apim-tce-dip-dlz02-graphql-obi4wan.azure-api.net/graphql we have been provided key which needs to be provided in header (Ocp-Apim-Subscription-Key)

Use cases​

  1. Customer want to retrieve maintenance years

    1. Chat bot will ask for postal code and house number and we can invoke endpoint with following payload
{
  serviceObjects(postCode: "2532 CT", number: 128  ){
  objectNumber
  state
  description
  brandCode
  brandDescription
  typeCode
  typeDescription
  modelCode
  modelDescription
  blocked
  createdDate 
  objectMaintenances{
    objectNumber
    objectDescription
    nextMaintenanceYear
  }  
 }
}

  1. Customer want to see the appliances they own

    1. Chat bot will ask for postal code, house number and suffix. We can invoke endpoint with following payload
{
    serviceObjects(number: 23, postCode: "1756VD", suffix: "") {
        description
        brandCode
        brandDescription        
        globalId
        modelCode
        modelDescription
        objectNumber
        typeCode
        typeDescription
    }
}

  1. Customer want to see work orders

    1. Chat bot will ask for postal code, address and last 3 digits of work order /phone number. We can invoke following endpoint to get details on work order
{
  workOrders(postCode: "1072 GV", address: "Rustenburgerstraat 387-3", workOrderNumber: "315"){
    workOrderNumber
    description
    startDate
    serviceOrder {
      serviceOrderObjects{
        objectNumber
        objectDescription
      }
    }
  }
}

  1. Customer want to cancel work orders

    1. Chat bot will ask for workOrderNumber ,description and last 3 digits of work order /phone number. We can invoke endpoint with following payload to cancel work order
{
 updateWorkOrder(workOrderNumber: "WCP00044425", description: "nbtestaa", actualReferencePoint : 105 ){
  workOrderNumber
  description
  modifiedDate
  sourceNumber
  }
}
  1. Customer want to modify work order (like change appointment date)
    Chat bot provides with list of options (this is also comes from comfort partners endpoint) they have and customer chooses one of it. We are yet to receive sketches and payload information.

5.1 Customers want to see alternative work order appointments

 alternativeWorkOrderAppointments(workOrderNumber: "WCP00158482") {
    earliestFinishDate
    earliestStartDate
    latestStartDate
    latestFinishDate
    timeBlock {
      startDate
      finishDate
    }
  }

5.2 Customer want to update the time of their work order

mutation {
  updateAppointmentOption(
    workOrderNumber: "WCP00044855"
    earliestArrivalDateTime: "2024-12-20T07:00:00.000Z"
    latestArrivalDateTime: "2024-12-20T11:00:00.000Z"
    earliestStartDate: "2024-12-20T07:00:00.000Z"
    optionResourceExternalCode : "111668"
  ) {
    executionStatus
    description
  }
}