Getting started

• Introduction
  • Before starting
  • End Point
• Service description
  • Methods and URL
  • Use case examples
• History of document

Introduction

This API allows to manage customer appointments with Orange Technicians :

• Create : depending on the status of the order
• Change : if an appointment is already scheduled and if the status allows to change
• Cancel : if an appointment is already scheduled and if the status allows to cancel

Before starting

It is requested to sign a contract with the marketing department of Orange Wholesale France to access this service.

/ ! \ This API requires an OAuth 2.0 2-legged authentication. Please follow the method described here.

End Point

https://api.orange.com/erdv/v1/

Service description

The exposed resource is interventionOrder. This API is based on TMF646 appointment of tmforum.

Methods and URL

Use case examples

GET /interventionOrder/00123456

Search the order with id 00123456.

 {
    "id": "00123456",
    "deliveryContractualDate": "2018-08-03",
    "operatorDriven": true,
    "clientSiteInterface": "Cuivre, ne pas laisser de modem",
    "installationType": "Cuivre",
    "operatorName": "OPERATEUR TELECOM",
    "relatedOrganization": {
        "tradingName": "Société & Co"
    },
    "serviceSpecification": {
        "id": "C2E",
        "name": "Core Ethernet Entreprise"
    },
    "intervention": {
        "customerContact": {
            "contactName": "Mr DUPONT Albert",
            "phoneNumber": "33 0111111111"
        }
    },
    "geographicSite": {
        "geographicAddress": {
            "streetNumber": "80",
            "streetName": "BOULEVARD DES ECUREUILS",
            "postCode": "12500",
            "city": "ESPALION",
            "geographicCode": "12096",
            "geographicSubAdress": {}
        }
    },
    "availableActivities": [
        {
            "id": "CRE",
            "value": "Cr?ation"
        },
        {
            "id": "CLA",
            "value": "Cession Ligne Active"
        }
    ],
    "availableAsbestos": [
        {
            "id": "SUP1997",
            "value": "Construction > 1997"
        },
        {
            "id": "INF1997_AVEC",
            "value": "Construction < 1997 avec Dossier Technique Amiante"
        },
        {
            "id": "INF1997_SANS",
            "value": "Construction < 1997 sans Dossier Technique Amiante"
        }
    ],
    "availableInternalServices": [
        {
            "id": "OF",
            "value": "Orange Forfait"
        },
        {
            "id": "IP",
            "value": "Installateur Privé"
        }
    ]
}

• availableActivities: list of available activities for the order. The id must be used in the request to search available time slots and create appointment.

• availableAsbestos: list of available asbestos values for the order. The id must be used in the request to create appointment.

• availableInternalServices: list of available internal service values for the order. The id must be used in the request to create appointment.

POST /interventionOrder/00123456/searchTimeSlot

Search available time slots for order with id 00123456 and activity CRE (creation).

Request

 {
  "relatedEntity": {
    "actionType": "CRE"
  },
  "requestedTimeSlot": {
    "validFor": {
        "startDate": "2019-07-28",
        "endDate": "2019-07-30"
      }
  }
}         

Response

 {
    "searchResult": "success",
    "availableTimeSlot": [
        {
            "validFor": {
                "startDateTime": "2019-07-28T08:00:00.000+0000",
                "endDateTime": "2019-07-28T10:00:00.000+0000"
            }
        },
        {
            "validFor": {
                "startDateTime": "2019-07-28T08:30:00.000+0000",
                "endDateTime": "2019-07-28T10:30:00.000+0000"
            }
        },
        {
            "validFor": {
                "startDateTime": "2019-07-28T09:00:00.000+0000",
                "endDateTime": "2019-07-28T11:00:00.000+0000"
            }
        },
        ....
        {
            "validFor": {
                "startDateTime": "2019-07-30T16:00:00.000+0000",
                "endDateTime": "2019-07-30T18:00:00.000+0000"
            }
        }
    ]
}

PATCH /interventionOrder/00123456

Create an appointment for order with id 00123456.

{
  "operatorDriven": true,
  "geographicSite": {
    "asbestos": "SUP1997",
    "geographicAddress": {
      "comment": "Accès par le fond de la cour, 2ème porte à droite",
      "geographicSubAddress": {
        "levelNumber": "4",
        "buildingName": "bâtiment"
      }
    }
  },
  "intervention": {
    "activity": "CRE",
    "internalService": "OF",
    "appointment": {
      "startDate": "2019-07-30T16:00:00.000+0000"
    },
    "customerContact": {
            "contactName": "Mr DUPONT Albert",
            "phoneNumber": "33 0111111111"
    }
  }
}

PATCH /interventionOrder/00123456/appointment

Change the appointment for order with id 00123456.

{
   "startDate": "2019-08-12T08:30:00.000+0000"
}

DELETE /interventionOrder/00123456/appointment

Cancel the appointment for order with id 00123456.

History of document

parcours

Return to the top