Service requests

Lists all the serviceRequests

Lists all the serviceRequests for the specified date range

get

/service-requests

Authorizations
Query parameters
startstring · date-timerequired

The inclusive start date

endstring · date-timerequired

The exclusive end date

Responses
curl -L \
  --url 'https://api.ecosuite.io//service-requests?start=2025-02-24T00%3A09%3A11.085Z&end=2025-02-24T00%3A09%3A11.085Z' \
  --header 'Authorization: YOUR_API_KEY'
{
  "range": {
    "localStartDate": "2025-02-24T00:09:11.085Z",
    "localEndDate": "2025-02-24T00:09:11.085Z"
  },
  "serviceRequests": [
    {
      "created": "2025-02-24T00:09:11.085Z",
      "closed": "2025-02-24T00:09:11.085Z",
      "taskSummary": "text",
      "onSiteContactNotes": "text",
      "contactNumber": "718-395-3620",
      "context": "text",
      "tasks": [
        "text"
      ],
      "events": [
        "text"
      ],
      "tools": [
        "text"
      ],
      "checklist": [
        "text"
      ],
      "location": {
        "project": "text",
        "site": "text",
        "system": "text"
      },
      "siteVisitWindow": {
        "start": "2025-02-24T00:09:11.085Z",
        "end": "2025-02-24T00:09:11.085Z"
      },
      "information": [
        {
          "text": "text",
          "link": "text"
        }
      ]
    }
  ]
}

successful operation

Create a new serviceRequest

Creates a new serviceRequest generating it a unique ID

post

/service-requests

Authorizations
Body
createdRequest Date
closedCompleted Date
taskSummaryTask Summaryrequired
onSiteContactNotesOn Site Contact Notes
contactNumberContact Number
contextContext of Issuerequired
tasksWork aimed to be completed
eventsRelated Events
toolsTools needed for work
checklistCheck list before leaving site
locationAssetrequired
siteVisitWindowSite Visit Window
informationInformation needed
Responses
curl -L \
  --request POST \
  --url 'https://api.ecosuite.io//service-requests' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"taskSummary":"text","contactNumber":"718-395-3620","context":"text","tasks":[null],"events":[null],"tools":[null],"checklist":[null],"location":{"project":"text","site":"text","system":"text"},"siteVisitWindow":{"start":"2025-02-24T00:09:11.085Z","end":"2025-02-24T00:09:11.085Z"},"information":[{"text":"text","link":"text"}]}'
{}

successful operation

Get serviceRequest details

Gets the details for the specified serviceRequest

get

/service-requests/{serviceRequestId}

Authorizations
Path parameters
serviceRequestIdstringrequired

The serviceRequest ID

Responses
curl -L \
  --url 'https://api.ecosuite.io//service-requests/{serviceRequestId}' \
  --header 'Authorization: YOUR_API_KEY'
{
  "serviceRequest": {
    "created": "2025-02-24T00:09:11.085Z",
    "closed": "2025-02-24T00:09:11.085Z",
    "taskSummary": "text",
    "onSiteContactNotes": "text",
    "contactNumber": "718-395-3620",
    "context": "text",
    "tasks": [
      "text"
    ],
    "events": [
      "text"
    ],
    "tools": [
      "text"
    ],
    "checklist": [
      "text"
    ],
    "location": {
      "project": "text",
      "site": "text",
      "system": "text"
    },
    "siteVisitWindow": {
      "start": "2025-02-24T00:09:11.085Z",
      "end": "2025-02-24T00:09:11.085Z"
    },
    "information": [
      {
        "text": "text",
        "link": "text"
      }
    ]
  }
}

successful operation

Update an existing serviceRequest

Update an existing serviceRequest

put

/service-requests/{serviceRequestId}

Authorizations
Path parameters
serviceRequestIdstringrequired

The serviceRequest ID

Body
createdRequest Date
closedCompleted Date
taskSummaryTask Summaryrequired
onSiteContactNotesOn Site Contact Notes
contactNumberContact Number
contextContext of Issuerequired
tasksWork aimed to be completed
eventsRelated Events
toolsTools needed for work
checklistCheck list before leaving site
locationAssetrequired
siteVisitWindowSite Visit Window
informationInformation needed
Responses
curl -L \
  --request PUT \
  --url 'https://api.ecosuite.io//service-requests/{serviceRequestId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"taskSummary":"text","contactNumber":"718-395-3620","context":"text","tasks":[null],"events":[null],"tools":[null],"checklist":[null],"location":{"project":"text","site":"text","system":"text"},"siteVisitWindow":{"start":"2025-02-24T00:09:11.085Z","end":"2025-02-24T00:09:11.085Z"},"information":[{"text":"text","link":"text"}]}'
{
  "serviceRequest": {
    "created": "2025-02-24T00:09:11.085Z",
    "closed": "2025-02-24T00:09:11.085Z",
    "taskSummary": "text",
    "onSiteContactNotes": "text",
    "contactNumber": "718-395-3620",
    "context": "text",
    "tasks": [
      "text"
    ],
    "events": [
      "text"
    ],
    "tools": [
      "text"
    ],
    "checklist": [
      "text"
    ],
    "location": {
      "project": "text",
      "site": "text",
      "system": "text"
    },
    "siteVisitWindow": {
      "start": "2025-02-24T00:09:11.085Z",
      "end": "2025-02-24T00:09:11.085Z"
    },
    "information": [
      {
        "text": "text",
        "link": "text"
      }
    ]
  }
}

successful operation

Deletes an existing serviceRequest

Deletes an existing serviceRequest

delete

/service-requests/{serviceRequestId}

Authorizations
Path parameters
serviceRequestIdstringrequired

The serviceRequest ID

Responses
curl -L \
  --request DELETE \
  --url 'https://api.ecosuite.io//service-requests/{serviceRequestId}' \
  --header 'Authorization: YOUR_API_KEY'
{}

successful operation

PreviousRecord documentsNextGenerate