Get Circuit by Order ID

GET

https://api.eis.it/v1/circuits/:orderId/:organizationId

GET

/v1/circuits/:orderId/:organizationId

curl https://api.eis.it/v1/circuits/1/1

200Retrieved

[
  {
    "id": 1,
    "supplierId": "string",
    "supplierProcedureId": "string",
    "resourceId": "string",
    "accountSupplier": "string",
    "insertDate": "string",
    "dad": "string",
    "appointmentDate": "string",
    "type": "string",
    "completeDate": "string",
    "residentialContext": "string",
    "stair": "string",
    "floor": "string",
    "unit": "string",
    "idBuilding": "string",
    "egonCode": "string",
    "timeSlot": "string",
    "firtNameRef": "string",
    "lastNameRef": "string",
    "fixedNumberRef": "string",
    "mobileNumberRef": "string",
    "emailRef": "string",
    "productName": "string",
    "koHistory": "string",
    "cow": "string",
    "cor": "string",
    "cos": "string",
    "contrChar": "string",
    "donating": "string",
    "donatingSocieta": "string",
    "publicIpv4": true,
    "publicIpv6": true,
    "organization": {
      "organizationId": 1,
      "userId": 1,
      "userName": "string",
      "createDate": "string",
      "modifiedDate": "string",
      "parentOrganizationId": 1,
      "name": "string",
      "type_": "string",
      "sbcId": 1,
      "documentation_URL": "string",
      "support_URL": "string",
      "status_URL": "string",
      "redirect_URL": "string",
      "notificationEmailFromAddress": "string",
      "customerId": "string"
    },
    "user": {
      "userId": 1,
      "ssoId": "string",
      "createDate": "string",
      "modifiedDate": "string",
      "emailAddress": "string",
      "firstName": "string",
      "lastName": "string",
      "hasToChangePassword": true,
      "type": {
        "id": 1,
        "name": "string"
      },
      "organizationId": 1,
      "parentOrganizationId": 1,
      "organizationName": "string"
    },
    "customer": {
      "id": 1,
      "organizationId": 1,
      "name": "string",
      "ragioneSociale": "string",
      "rappresentante": "string",
      "indirizzo": "string",
      "civico": "string",
      "indSedLeg": "string",
      "civicoSedLeg": "string",
      "comuneSedLeg": "string",
      "provinciaSedLeg": "string",
      "regioneSedLeg": "string",
      "capSedLeg": "string",
      "comune": "string",
      "provincia": "string",
      "regione": "string",
      "cap": "string",
      "tel": "string",
      "fiscalCode": "string",
      "isActive": "string",
      "userid": 1,
      "customerPortal": true,
      "associated_users": [
        "string"
      ],
      "piva": "string",
      "ptoponomastica": "string"
    },
    "status": {
      "id": 1,
      "code": "string",
      "description": "string",
      "finishStatus": true
    },
    "profile": {
      "id": 1,
      "serviceList": {
        "id": 1,
        "name": "string",
        "serviceProvider": {
          "id": 1,
          "description": "string"
        },
        "carrier": {
          "id": 1,
          "name": "string"
        },
        "type": {
          "id": 1,
          "name": "string"
        },
        "supplierProductId": "string"
      },
      "organizationId": 1,
      "integration": {
        "id": 1,
        "name": "string"
      },
      "name": "string",
      "forDirect": true,
      "forSub": true,
      "carrierType": "string",
      "offsetDays": 1
    },
    "drt": null,
    "ipV4": null,
    "ipV6": null,
    "mcr": null,
    "sla": null
  }
]

Retrieve circuit information for a specific order ID. The organization is selected explicitly through the organizationId path parameter.

Path parameters

orderIdintegerRequired

organizationIdlongRequired

Organization identifier.

Response

This endpoint returns a list of objects.

idintegerOptional

supplierIdstringOptional

supplierProcedureIdstring or nullOptional

resourceIdstring or nullOptional

accountSupplierstringOptional

insertDatestringOptional

dadstringOptional

appointmentDatestring or nullOptional

Format: dd/MM/yyyy HH:mm

typestringOptional

completeDatestring or nullOptional

residentialContextstring or nullOptional

stairstring or nullOptional

floorstring or nullOptional

unitstring or nullOptional

idBuildingstring or nullOptional

egonCodestring or nullOptional

timeSlotstringOptional

firtNameRefstringOptional

lastNameRefstringOptional

fixedNumberRefstringOptional

mobileNumberRefstringOptional

emailRefstringOptional

productNamestringOptional

koHistorystring or nullOptional

cowstring or nullOptional

corstring or nullOptional

cosstring or nullOptional

contrCharstring or nullOptional

donatingstring or nullOptional

donatingSocietastring or nullOptional

publicIpv4booleanOptional

publicIpv6booleanOptional

organizationobjectOptional

userobjectOptional

customerobjectOptional

statusobjectOptional

profileobjectOptional