Business Apps France
Boost your SaaS revenue by joining Orange Business Services' partner program.

API ProductOrdering

[BASE URL: /, API VERSION: 1.0-SNAPSHOT, HOST: http://api.orange.com]
    • implementation notes

      Sends events regarding the productOrder delivery progression

      response class (status 201)
      {
        "id": "string",
        "type": "completedStateNotification",
        "time": "2017-10-13T12:09:57.715Z",
        "resource": {
          "id": "string",
          "state": "initialized",
          "orderItem": [
            {
              "id": "string",
              "state": "initialized",
              "action": "add",
              "productRef": {
                "id": "string",
                "characteristic": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ],
                "userServiceQuantity": 0
              },
              "productOffering": {
                "name": "string",
                "externalReference": {
                  "type": "orange",
                  "id": "string"
                }
              }
            }
          ],
          "category": "trial",
          "note": {
            "text": "string",
            "date": "2017-10-13T12:09:57.707Z",
            "author": "string"
          },
          "orderDate": "2017-10-13T12:09:57.707Z",
          "completionDate": "2017-10-13T12:09:57.707Z",
          "requestedStartDate": "2017-10-13T12:09:57.707Z",
          "relatedContact": [
            {
              "role": "customerFleetManager",
              "characteristic": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "givenName": "string",
              "familyName": "string",
              "fixedTelephoneNumber": {
                "cc": "string",
                "sn": "string"
              },
              "mobileNumber": {
                "cc": "string",
                "sn": "string"
              },
              "email": "string",
              "postalAddress": {
                "streetNumber": {
                  "number": "string",
                  "letter": "string"
                },
                "street1": "string",
                "street2": "string",
                "postcode": "string",
                "city": "string",
                "stateOrProvince": "string",
                "country": "string"
              },
              "externalReference": {
                "type": "orange",
                "id": "string"
              }
            }
          ],
          "relatedOrganization": {
            "id": "string",
            "registrationNumber": {
              "id": "string",
              "type": "string",
              "issuingAuthority": "INSEE"
            },
            "characteristic": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "tradingName": "string",
            "postalAddress": {
              "streetNumber": {
                "number": "string",
                "letter": "string"
              },
              "street1": "string",
              "street2": "string",
              "postcode": "string",
              "city": "string",
              "stateOrProvince": "string",
              "country": "string"
            },
            "role": "customer",
            "externalReference": {
              "type": "orange",
              "id": "string"
            }
          },
          "relatedEndUserConfiguration": [
            {
              "endUser": {
                "role": "customerFleetManager",
                "characteristic": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ],
                "givenName": "string",
                "familyName": "string",
                "fixedTelephoneNumber": {
                  "cc": "string",
                  "sn": "string"
                },
                "mobileNumber": {
                  "cc": "string",
                  "sn": "string"
                },
                "email": "string",
                "postalAddress": {
                  "streetNumber": {
                    "number": "string",
                    "letter": "string"
                  },
                  "street1": "string",
                  "street2": "string",
                  "postcode": "string",
                  "city": "string",
                  "stateOrProvince": "string",
                  "country": "string"
                },
                "externalReference": {
                  "type": "orange",
                  "id": "string"
                }
              },
              "relatedRealizingResource": {
                "name": "string",
                "characteristic": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ]
              }
            }
          ],
          "externalReference": {
            "type": "orange",
            "id": "string"
          }
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      body
      {
        "id": "string",
        "type": "completedStateNotification",
        "time": "2017-10-13T12:09:57.715Z",
        "resource": {
          "id": "string",
          "state": "initialized",
          "orderItem": [
            {
              "id": "string",
              "state": "initialized",
              "action": "add",
              "productRef": {
                "id": "string",
                "characteristic": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ],
                "userServiceQuantity": 0
              },
              "productOffering": {
                "name": "string",
                "externalReference": {
                  "type": "orange",
                  "id": "string"
                }
              }
            }
          ],
          "category": "trial",
          "note": {
            "text": "string",
            "date": "2017-10-13T12:09:57.707Z",
            "author": "string"
          },
          "orderDate": "2017-10-13T12:09:57.707Z",
          "completionDate": "2017-10-13T12:09:57.707Z",
          "requestedStartDate": "2017-10-13T12:09:57.707Z",
          "relatedContact": [
            {
              "role": "customerFleetManager",
              "characteristic": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "givenName": "string",
              "familyName": "string",
              "fixedTelephoneNumber": {
                "cc": "string",
                "sn": "string"
              },
              "mobileNumber": {
                "cc": "string",
                "sn": "string"
              },
              "email": "string",
              "postalAddress": {
                "streetNumber": {
                  "number": "string",
                  "letter": "string"
                },
                "street1": "string",
                "street2": "string",
                "postcode": "string",
                "city": "string",
                "stateOrProvince": "string",
                "country": "string"
              },
              "externalReference": {
                "type": "orange",
                "id": "string"
              }
            }
          ],
          "relatedOrganization": {
            "id": "string",
            "registrationNumber": {
              "id": "string",
              "type": "string",
              "issuingAuthority": "INSEE"
            },
            "characteristic": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "tradingName": "string",
            "postalAddress": {
              "streetNumber": {
                "number": "string",
                "letter": "string"
              },
              "street1": "string",
              "street2": "string",
              "postcode": "string",
              "city": "string",
              "stateOrProvince": "string",
              "country": "string"
            },
            "role": "customer",
            "externalReference": {
              "type": "orange",
              "id": "string"
            }
          },
          "relatedEndUserConfiguration": [
            {
              "endUser": {
                "role": "customerFleetManager",
                "characteristic": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ],
                "givenName": "string",
                "familyName": "string",
                "fixedTelephoneNumber": {
                  "cc": "string",
                  "sn": "string"
                },
                "mobileNumber": {
                  "cc": "string",
                  "sn": "string"
                },
                "email": "string",
                "postalAddress": {
                  "streetNumber": {
                    "number": "string",
                    "letter": "string"
                  },
                  "street1": "string",
                  "street2": "string",
                  "postcode": "string",
                  "city": "string",
                  "stateOrProvince": "string",
                  "country": "string"
                },
                "externalReference": {
                  "type": "orange",
                  "id": "string"
                }
              },
              "relatedRealizingResource": {
                "name": "string",
                "characteristic": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ]
              }
            }
          ],
          "externalReference": {
            "type": "orange",
            "id": "string"
          }
        }
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400bad_request
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }
      422unprocessable_entity
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }
    • implementation notes

      Creation of one application for a customer, Add new licences for one existing application, Terminate an application for a customer

      response class (status 201)
      {
        "id": "string",
        "state": "initialized",
        "orderItem": [
          {
            "id": "string",
            "state": "initialized",
            "action": "add",
            "productRef": {
              "id": "string",
              "characteristic": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "userServiceQuantity": 0
            },
            "productOffering": {
              "name": "string",
              "externalReference": {
                "type": "orange",
                "id": "string"
              }
            }
          }
        ],
        "category": "trial",
        "note": {
          "text": "string",
          "date": "2017-10-13T12:09:57.707Z",
          "author": "string"
        },
        "orderDate": "2017-10-13T12:09:57.707Z",
        "completionDate": "2017-10-13T12:09:57.707Z",
        "requestedStartDate": "2017-10-13T12:09:57.707Z",
        "relatedContact": [
          {
            "role": "customerFleetManager",
            "characteristic": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "givenName": "string",
            "familyName": "string",
            "fixedTelephoneNumber": {
              "cc": "string",
              "sn": "string"
            },
            "mobileNumber": {
              "cc": "string",
              "sn": "string"
            },
            "email": "string",
            "postalAddress": {
              "streetNumber": {
                "number": "string",
                "letter": "string"
              },
              "street1": "string",
              "street2": "string",
              "postcode": "string",
              "city": "string",
              "stateOrProvince": "string",
              "country": "string"
            },
            "externalReference": {
              "type": "orange",
              "id": "string"
            }
          }
        ],
        "relatedOrganization": {
          "id": "string",
          "registrationNumber": {
            "id": "string",
            "type": "string",
            "issuingAuthority": "INSEE"
          },
          "characteristic": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "tradingName": "string",
          "postalAddress": {
            "streetNumber": {
              "number": "string",
              "letter": "string"
            },
            "street1": "string",
            "street2": "string",
            "postcode": "string",
            "city": "string",
            "stateOrProvince": "string",
            "country": "string"
          },
          "role": "customer",
          "externalReference": {
            "type": "orange",
            "id": "string"
          }
        },
        "relatedEndUserConfiguration": [
          {
            "endUser": {
              "role": "customerFleetManager",
              "characteristic": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "givenName": "string",
              "familyName": "string",
              "fixedTelephoneNumber": {
                "cc": "string",
                "sn": "string"
              },
              "mobileNumber": {
                "cc": "string",
                "sn": "string"
              },
              "email": "string",
              "postalAddress": {
                "streetNumber": {
                  "number": "string",
                  "letter": "string"
                },
                "street1": "string",
                "street2": "string",
                "postcode": "string",
                "city": "string",
                "stateOrProvince": "string",
                "country": "string"
              },
              "externalReference": {
                "type": "orange",
                "id": "string"
              }
            },
            "relatedRealizingResource": {
              "name": "string",
              "characteristic": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          }
        ],
        "externalReference": {
          "type": "orange",
          "id": "string"
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      body
      {
        "id": "string",
        "state": "initialized",
        "orderItem": [
          {
            "id": "string",
            "state": "initialized",
            "action": "add",
            "productRef": {
              "id": "string",
              "characteristic": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "userServiceQuantity": 0
            },
            "productOffering": {
              "name": "string",
              "externalReference": {
                "type": "orange",
                "id": "string"
              }
            }
          }
        ],
        "category": "trial",
        "note": {
          "text": "string",
          "date": "2017-10-13T12:09:57.707Z",
          "author": "string"
        },
        "orderDate": "2017-10-13T12:09:57.707Z",
        "completionDate": "2017-10-13T12:09:57.707Z",
        "requestedStartDate": "2017-10-13T12:09:57.707Z",
        "relatedContact": [
          {
            "role": "customerFleetManager",
            "characteristic": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "givenName": "string",
            "familyName": "string",
            "fixedTelephoneNumber": {
              "cc": "string",
              "sn": "string"
            },
            "mobileNumber": {
              "cc": "string",
              "sn": "string"
            },
            "email": "string",
            "postalAddress": {
              "streetNumber": {
                "number": "string",
                "letter": "string"
              },
              "street1": "string",
              "street2": "string",
              "postcode": "string",
              "city": "string",
              "stateOrProvince": "string",
              "country": "string"
            },
            "externalReference": {
              "type": "orange",
              "id": "string"
            }
          }
        ],
        "relatedOrganization": {
          "id": "string",
          "registrationNumber": {
            "id": "string",
            "type": "string",
            "issuingAuthority": "INSEE"
          },
          "characteristic": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "tradingName": "string",
          "postalAddress": {
            "streetNumber": {
              "number": "string",
              "letter": "string"
            },
            "street1": "string",
            "street2": "string",
            "postcode": "string",
            "city": "string",
            "stateOrProvince": "string",
            "country": "string"
          },
          "role": "customer",
          "externalReference": {
            "type": "orange",
            "id": "string"
          }
        },
        "relatedEndUserConfiguration": [
          {
            "endUser": {
              "role": "customerFleetManager",
              "characteristic": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "givenName": "string",
              "familyName": "string",
              "fixedTelephoneNumber": {
                "cc": "string",
                "sn": "string"
              },
              "mobileNumber": {
                "cc": "string",
                "sn": "string"
              },
              "email": "string",
              "postalAddress": {
                "streetNumber": {
                  "number": "string",
                  "letter": "string"
                },
                "street1": "string",
                "street2": "string",
                "postcode": "string",
                "city": "string",
                "stateOrProvince": "string",
                "country": "string"
              },
              "externalReference": {
                "type": "orange",
                "id": "string"
              }
            },
            "relatedRealizingResource": {
              "name": "string",
              "characteristic": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          }
        ],
        "externalReference": {
          "type": "orange",
          "id": "string"
        }
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400bad_request
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }
      422unprocessable_entity
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }

API UserService

[BASE URL: /, API VERSION: 1.1-SNAPSHOT, HOST: http://api.orange.com]
    • response class (status 201)
      {
        "id": "string",
        "type": "updateNotification",
        "time": "2017-10-13T12:09:58.007Z",
        "resource": {
          "id": "string",
          "externalReference": {
            "type": "orange",
            "id": "string"
          },
          "state": "acknowledged",
          "userService": [
            {
              "id": "string",
              "state": "active",
              "externalState": "active",
              "relatedProductRefId": "string",
              "relatedProductOfferingOperation": {
                "action": "swap",
                "externalReference": {
                  "type": "orange",
                  "id": "string"
                },
                "name": "string"
              },
              "note": {
                "text": "string",
                "date": "2017-10-13T12:09:58.002Z",
                "author": "string"
              },
              "validFor": {
                "startDate": "2017-10-13T12:09:58.002Z",
                "endDate": "2017-10-13T12:09:58.002Z"
              },
              "updateDate": "2017-10-13T12:09:58.002Z",
              "updateState": "initialized",
              "relatedEndUserConfigurationOperation": {
                "endUserOperation": {
                  "action": "add",
                  "endUser": {
                    "id": "string",
                    "givenName": "string",
                    "mobileNumber": {
                      "cc": "string",
                      "sn": "string"
                    },
                    "fixedTelephoneNumber": {
                      "cc": "string",
                      "sn": "string"
                    },
                    "familyName": "string",
                    "email": "string",
                    "postalAddress": {
                      "streetNumber": {
                        "number": "string",
                        "letter": "string"
                      },
                      "postcode": "string",
                      "stateOrProvince": "string",
                      "street1": "string",
                      "street2": "string",
                      "country": "string",
                      "city": "string"
                    },
                    "externalReference": {
                      "type": "orange",
                      "id": "string"
                    }
                  }
                },
                "realizingResourceOperation": {
                  "action": "add",
                  "realizingResource": {
                    "name": "string",
                    "value": [
                      {
                        "name": "string",
                        "value": "string"
                      }
                    ]
                  }
                }
              },
              "relatedRightOperation": {
                "action": "add",
                "loginMap": [
                  {
                    "key": "login",
                    "value": "string"
                  }
                ],
                "email": "string"
              },
              "relatedServiceCharacteristicOperation": [
                {
                  "action": "add",
                  "characteristic": {
                    "name": "string",
                    "value": "string"
                  }
                }
              ]
            }
          ]
        }
      }
      parameters
      parametervaluedescriptionparameter typedata type
      body
      {
        "id": "string",
        "type": "updateNotification",
        "time": "2017-10-13T12:09:58.007Z",
        "resource": {
          "id": "string",
          "externalReference": {
            "type": "orange",
            "id": "string"
          },
          "state": "acknowledged",
          "userService": [
            {
              "id": "string",
              "state": "active",
              "externalState": "active",
              "relatedProductRefId": "string",
              "relatedProductOfferingOperation": {
                "action": "swap",
                "externalReference": {
                  "type": "orange",
                  "id": "string"
                },
                "name": "string"
              },
              "note": {
                "text": "string",
                "date": "2017-10-13T12:09:58.002Z",
                "author": "string"
              },
              "validFor": {
                "startDate": "2017-10-13T12:09:58.002Z",
                "endDate": "2017-10-13T12:09:58.002Z"
              },
              "updateDate": "2017-10-13T12:09:58.002Z",
              "updateState": "initialized",
              "relatedEndUserConfigurationOperation": {
                "endUserOperation": {
                  "action": "add",
                  "endUser": {
                    "id": "string",
                    "givenName": "string",
                    "mobileNumber": {
                      "cc": "string",
                      "sn": "string"
                    },
                    "fixedTelephoneNumber": {
                      "cc": "string",
                      "sn": "string"
                    },
                    "familyName": "string",
                    "email": "string",
                    "postalAddress": {
                      "streetNumber": {
                        "number": "string",
                        "letter": "string"
                      },
                      "postcode": "string",
                      "stateOrProvince": "string",
                      "street1": "string",
                      "street2": "string",
                      "country": "string",
                      "city": "string"
                    },
                    "externalReference": {
                      "type": "orange",
                      "id": "string"
                    }
                  }
                },
                "realizingResourceOperation": {
                  "action": "add",
                  "realizingResource": {
                    "name": "string",
                    "value": [
                      {
                        "name": "string",
                        "value": "string"
                      }
                    ]
                  }
                }
              },
              "relatedRightOperation": {
                "action": "add",
                "loginMap": [
                  {
                    "key": "login",
                    "value": "string"
                  }
                ],
                "email": "string"
              },
              "relatedServiceCharacteristicOperation": [
                {
                  "action": "add",
                  "characteristic": {
                    "name": "string",
                    "value": "string"
                  }
                }
              ]
            }
          ]
        }
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400bad_request
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }
      422unprocessable_entity
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }
    • response class (status 200)
      [
        {
          "id": "string",
          "state": "active",
          "externalState": "active",
          "relatedProductRefId": "string",
          "relatedProductOfferingOperation": {
            "action": "swap",
            "externalReference": {
              "type": "orange",
              "id": "string"
            },
            "name": "string"
          },
          "note": {
            "text": "string",
            "date": "2017-10-13T12:09:58.002Z",
            "author": "string"
          },
          "validFor": {
            "startDate": "2017-10-13T12:09:58.002Z",
            "endDate": "2017-10-13T12:09:58.002Z"
          },
          "updateDate": "2017-10-13T12:09:58.002Z",
          "updateState": "initialized",
          "relatedEndUserConfigurationOperation": {
            "endUserOperation": {
              "action": "add",
              "endUser": {
                "id": "string",
                "givenName": "string",
                "mobileNumber": {
                  "cc": "string",
                  "sn": "string"
                },
                "fixedTelephoneNumber": {
                  "cc": "string",
                  "sn": "string"
                },
                "familyName": "string",
                "email": "string",
                "postalAddress": {
                  "streetNumber": {
                    "number": "string",
                    "letter": "string"
                  },
                  "postcode": "string",
                  "stateOrProvince": "string",
                  "street1": "string",
                  "street2": "string",
                  "country": "string",
                  "city": "string"
                },
                "externalReference": {
                  "type": "orange",
                  "id": "string"
                }
              }
            },
            "realizingResourceOperation": {
              "action": "add",
              "realizingResource": {
                "name": "string",
                "value": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ]
              }
            }
          },
          "relatedRightOperation": {
            "action": "add",
            "loginMap": [
              {
                "key": "login",
                "value": "string"
              }
            ],
            "email": "string"
          },
          "relatedServiceCharacteristicOperation": [
            {
              "action": "add",
              "characteristic": {
                "name": "string",
                "value": "string"
              }
            }
          ]
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      list several userService by id ex id=1,2,3,4querystring
      list several userService grouped by ProductRefIdquerystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400bad_request
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }
      422unprocessable_entity
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }
    • response class (status 200)
      [
        {
          "id": "string",
          "state": "active",
          "externalState": "active",
          "relatedProductRefId": "string",
          "relatedProductOfferingOperation": {
            "action": "swap",
            "externalReference": {
              "type": "orange",
              "id": "string"
            },
            "name": "string"
          },
          "note": {
            "text": "string",
            "date": "2017-10-13T12:09:58.002Z",
            "author": "string"
          },
          "validFor": {
            "startDate": "2017-10-13T12:09:58.002Z",
            "endDate": "2017-10-13T12:09:58.002Z"
          },
          "updateDate": "2017-10-13T12:09:58.002Z",
          "updateState": "initialized",
          "relatedEndUserConfigurationOperation": {
            "endUserOperation": {
              "action": "add",
              "endUser": {
                "id": "string",
                "givenName": "string",
                "mobileNumber": {
                  "cc": "string",
                  "sn": "string"
                },
                "fixedTelephoneNumber": {
                  "cc": "string",
                  "sn": "string"
                },
                "familyName": "string",
                "email": "string",
                "postalAddress": {
                  "streetNumber": {
                    "number": "string",
                    "letter": "string"
                  },
                  "postcode": "string",
                  "stateOrProvince": "string",
                  "street1": "string",
                  "street2": "string",
                  "country": "string",
                  "city": "string"
                },
                "externalReference": {
                  "type": "orange",
                  "id": "string"
                }
              }
            },
            "realizingResourceOperation": {
              "action": "add",
              "realizingResource": {
                "name": "string",
                "value": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ]
              }
            }
          },
          "relatedRightOperation": {
            "action": "add",
            "loginMap": [
              {
                "key": "login",
                "value": "string"
              }
            ],
            "email": "string"
          },
          "relatedServiceCharacteristicOperation": [
            {
              "action": "add",
              "characteristic": {
                "name": "string",
                "value": "string"
              }
            }
          ]
        }
      ]
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400bad_request
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }
      422unprocessable_entity
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }
    • response class (status 201)
      {
        "id": "string",
        "externalReference": {
          "type": "orange",
          "id": "string"
        },
        "state": "acknowledged",
        "userService": [
          {
            "id": "string",
            "state": "active",
            "externalState": "active",
            "relatedProductRefId": "string",
            "relatedProductOfferingOperation": {
              "action": "swap",
              "externalReference": {
                "type": "orange",
                "id": "string"
              },
              "name": "string"
            },
            "note": {
              "text": "string",
              "date": "2017-10-13T12:09:58.002Z",
              "author": "string"
            },
            "validFor": {
              "startDate": "2017-10-13T12:09:58.002Z",
              "endDate": "2017-10-13T12:09:58.002Z"
            },
            "updateDate": "2017-10-13T12:09:58.002Z",
            "updateState": "initialized",
            "relatedEndUserConfigurationOperation": {
              "endUserOperation": {
                "action": "add",
                "endUser": {
                  "id": "string",
                  "givenName": "string",
                  "mobileNumber": {
                    "cc": "string",
                    "sn": "string"
                  },
                  "fixedTelephoneNumber": {
                    "cc": "string",
                    "sn": "string"
                  },
                  "familyName": "string",
                  "email": "string",
                  "postalAddress": {
                    "streetNumber": {
                      "number": "string",
                      "letter": "string"
                    },
                    "postcode": "string",
                    "stateOrProvince": "string",
                    "street1": "string",
                    "street2": "string",
                    "country": "string",
                    "city": "string"
                  },
                  "externalReference": {
                    "type": "orange",
                    "id": "string"
                  }
                }
              },
              "realizingResourceOperation": {
                "action": "add",
                "realizingResource": {
                  "name": "string",
                  "value": [
                    {
                      "name": "string",
                      "value": "string"
                    }
                  ]
                }
              }
            },
            "relatedRightOperation": {
              "action": "add",
              "loginMap": [
                {
                  "key": "login",
                  "value": "string"
                }
              ],
              "email": "string"
            },
            "relatedServiceCharacteristicOperation": [
              {
                "action": "add",
                "characteristic": {
                  "name": "string",
                  "value": "string"
                }
              }
            ]
          }
        ]
      }
      parameters
      parametervaluedescriptionparameter typedata type
      UserServiceUpdatebody
      {
        "id": "string",
        "externalReference": {
          "type": "orange",
          "id": "string"
        },
        "state": "acknowledged",
        "userService": [
          {
            "id": "string",
            "state": "active",
            "externalState": "active",
            "relatedProductRefId": "string",
            "relatedProductOfferingOperation": {
              "action": "swap",
              "externalReference": {
                "type": "orange",
                "id": "string"
              },
              "name": "string"
            },
            "note": {
              "text": "string",
              "date": "2017-10-13T12:09:58.002Z",
              "author": "string"
            },
            "validFor": {
              "startDate": "2017-10-13T12:09:58.002Z",
              "endDate": "2017-10-13T12:09:58.002Z"
            },
            "updateDate": "2017-10-13T12:09:58.002Z",
            "updateState": "initialized",
            "relatedEndUserConfigurationOperation": {
              "endUserOperation": {
                "action": "add",
                "endUser": {
                  "id": "string",
                  "givenName": "string",
                  "mobileNumber": {
                    "cc": "string",
                    "sn": "string"
                  },
                  "fixedTelephoneNumber": {
                    "cc": "string",
                    "sn": "string"
                  },
                  "familyName": "string",
                  "email": "string",
                  "postalAddress": {
                    "streetNumber": {
                      "number": "string",
                      "letter": "string"
                    },
                    "postcode": "string",
                    "stateOrProvince": "string",
                    "street1": "string",
                    "street2": "string",
                    "country": "string",
                    "city": "string"
                  },
                  "externalReference": {
                    "type": "orange",
                    "id": "string"
                  }
                }
              },
              "realizingResourceOperation": {
                "action": "add",
                "realizingResource": {
                  "name": "string",
                  "value": [
                    {
                      "name": "string",
                      "value": "string"
                    }
                  ]
                }
              }
            },
            "relatedRightOperation": {
              "action": "add",
              "loginMap": [
                {
                  "key": "login",
                  "value": "string"
                }
              ],
              "email": "string"
            },
            "relatedServiceCharacteristicOperation": [
              {
                "action": "add",
                "characteristic": {
                  "name": "string",
                  "value": "string"
                }
              }
            ]
          }
        ]
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400bad_request
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }
      422unprocessable_entity
      {
        "code": 0,
        "message": "string",
        "description": "string",
        "infoURL": "string"
      }
    • HTTP status codereasonresponse model
      400List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value
      {
        "code": 28,
        "message": "Invalid query-string parameter value",
        "description": "One or more query-string parameters contain invalid values."
      }
      401List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials
      {
        "code": 42,
        "message": "Expired credentials",
        "description": "The requested service needs credentials, and the ones provided were out-of-date."
      }
      403List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests
      {
        "code": 53,
        "message": "Too many requests",
        "description": "The application has made too many calls and has exceeded the rate limit for this service."
      }
      404List of supported error codes:
      - 60: Resource not found
      {
        "code": 60,
        "message": "Resource not found",
        "description": "The requested URI or the requested resource does not exist."
      }
      405List of supported error codes:
      - 61: Method not allowed
      {
        "code": 61,
        "message": "Method not allowed",
        "description": "The URI does not support the requested method. The available methods should be set in the response header 'Allow'"
      }
      406List of supported error codes:
      - 62: Not acceptable
      {
        "code": 62,
        "message": "Not acceptable",
        "description": "The Accept incoming header does not match any available content-type."
      }
      408List of supported error codes:
      - 63: Request time-out
      {
        "code": 63,
        "message": "Request time-out",
        "description": "The server timed out waiting for the incoming request."
      }
      411List of supported error codes:
      - 64: Length required
      {
        "code": 64,
        "message": "Length required",
        "description": "The request did not specify a Content-Length header, which is required by the requested resource."
      }
      412List of supported error codes:
      - 65: Precondition failed
      {
        "code": 65,
        "message": "Precondition failed",
        "description": "One of the precondition request headers (aka. 'If-None-Match', 'If-Match', 'If-Modified-Since', and 'If-Unmodified-Since') failed to match."
      }
      413List of supported error codes:
      - 66: Request entity too large
      {
        "code": 66,
        "message": "Request entity too large",
        "description": "The body of a request (PATCH, POST and PUT methods) is larger than the server is willing or able to process."
      }
      414List of supported error codes:
      - 67: Request-URI too long
      {
        "code": 67,
        "message": "Request-URI too long",
        "description": "The URI provided was too long for the server to process."
      }
      415List of supported error codes:
      - 68: Unsupported Media Type
      {
        "code": 68,
        "message": "Unsupported Media Type",
        "description": "The format of the posted body is not supported by the endpoint."
      }
      500List of supported error codes:
      - 1: Internal error
      {
        "code": 1,
        "message": "internal error",
        "description": "Generic failure message, used if no more precise code can be provided."
      }
      503List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !
      {
        "code": 6,
        "message": "Orange API is over capacity, retry later !",
        "description": "The service faces too much requests and can not handle the call."
      }