{
  "opencollection": "1.0.0",
  "info": {
    "name": "Appointment Management",
    "version": "3.0.1"
  },
  "items": [
    {
      "info": {
        "name": "appointment",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List or found Appointment objects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{serverBase}/mefApi/sonata/appointment/v3/appointment",
            "params": [
              {
                "name": "workOrderId",
                "value": "",
                "type": "query",
                "description": "A reference to a WorkOrder for which the Appointment is created."
              },
              {
                "name": "validFor.gt",
                "value": "",
                "type": "query",
                "description": "The Date and Time the Appointment is confirmed to start and end - greater than."
              },
              {
                "name": "validFor.lt",
                "value": "",
                "type": "query",
                "description": "The Date and Time the Appointment is confirmed to start and end - lower than."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "The status of the Appointment."
              },
              {
                "name": "geographicSiteId",
                "value": "",
                "type": "query",
                "description": "A site identifier that is associated with the Appointment."
              },
              {
                "name": "geographicAddressId",
                "value": "",
                "type": "query",
                "description": "An address identifier that is associated with the Appointment."
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer."
              },
              {
                "name": "sellerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Requested index for the start of resources to be provided in response"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Requested number of resources to be provided in response"
              }
            ]
          },
          "docs": "The Buyer requests a list of Appointment from the Seller based on a set of specified filter criteria. The Seller returns a summarized list of Appointments.\n"
        },
        {
          "info": {
            "name": "Creates an appointment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{serverBase}/mefApi/sonata/appointment/v3/appointment",
            "params": [
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer."
              },
              {
                "name": "sellerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "A request initiated by the Buyer to create a Appointment in the Seller's system to report an Issue experienced by the Buyer"
        },
        {
          "info": {
            "name": "Retrieves an Appointment by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{serverBase}/mefApi/sonata/appointment/v3/appointment/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique (within the Seller domain) identifier for the Appointment."
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer."
              },
              {
                "name": "sellerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller."
              }
            ]
          },
          "docs": "The Buyer requests detailed information about a single Appointment based on the Appointment Identifier."
        },
        {
          "info": {
            "name": "Updates partially an Appointment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{serverBase}/mefApi/sonata/appointment/v3/appointment/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique (within the Seller domain) identifier for the Appointment."
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer."
              },
              {
                "name": "sellerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "A request by the Buyer to patch an Appointment created by the Buyer in the Seller's system."
        }
      ]
    },
    {
      "info": {
        "name": "appointment operations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Cancels an Appointment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{serverBase}/mefApi/sonata/appointment/v3/appointment/:id/cancel",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique (within the Seller domain) identifier for the Appointment."
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer."
              },
              {
                "name": "sellerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity\n represents more than one Seller."
              }
            ]
          },
          "docs": "This operation sends a cancellation request."
        }
      ]
    },
    {
      "info": {
        "name": "searchTimeSlot",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Creates a SearchTimeSlot",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{serverBase}/mefApi/sonata/appointment/v3/searchTimeSlot",
            "params": [
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer."
              },
              {
                "name": "sellerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "A request by the Buyer to find a set of available time slots for scheduling or rescheduling an Appointment for a Workorder with a Seller Technician."
        }
      ]
    },
    {
      "info": {
        "name": "events subscription",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Allows the Buyer to register to Appointment status change notifications",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{serverBase}/mefApi/sonata/appointment/v3/hub",
            "params": [
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer."
              },
              {
                "name": "sellerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The Buyer requests to subscribe to Appointment Notifications."
        },
        {
          "info": {
            "name": "Retrieves a Hub by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{serverBase}/mefApi/sonata/appointment/v3/hub/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier of the Hub"
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer."
              },
              {
                "name": "sellerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity  represents more than one Seller."
              }
            ]
          },
          "docs": "This operation retrieves a hub entity."
        },
        {
          "info": {
            "name": "Unregister a listener",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{serverBase}/mefApi/sonata/appointment/v3/hub/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the EventSubscription"
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer."
              },
              {
                "name": "sellerId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller."
              }
            ]
          },
          "docs": "The Buyer requests to unsubscribe from Appointment Notifications"
        }
      ]
    }
  ],
  "bundled": true
}