Service requests

Lists all the serviceRequests

get

Lists all the serviceRequests for the specified date range

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Query parameters

startstring · date-timeRequired

The inclusive start date

endstring · date-timeRequired

The exclusive end date

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/service-requests

HTTPcURLJavaScriptPython

GET /service-requests?start=2025-12-19T20%3A43%3A41.292Z&end=2025-12-19T20%3A43%3A41.292Z HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "serviceRequests": [
    {
      "location": {
        "project": "text",
        "site": "text",
        "system": "text"
      },
      "created": "2025-12-19T20:43:41.292Z",
      "closed": "2025-12-19T20:43:41.292Z",
      "siteVisitWindow": {
        "start": "2025-12-19T20:43:41.292Z",
        "end": "2025-12-19T20:43:41.292Z"
      },
      "taskSummary": "text",
      "onSiteContactNotes": "text",
      "contactNumber": "718-395-3620",
      "context": "text",
      "tasks": [
        "text"
      ],
      "events": [
        "text"
      ],
      "tools": [
        "text"
      ],
      "information": [
        {
          "text": "text",
          "link": "text"
        }
      ],
      "checklist": [
        "text"
      ]
    }
  ],
  "range": {
    "localStartDate": "2025-12-19T20:43:41.292Z",
    "localEndDate": "2025-12-19T20:43:41.292Z"
  }
}

Create a new serviceRequest

post

Creates a new serviceRequest generating it a unique ID

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Body

application/json

Refer to the /schemas/service-request endpoint for the full JSON Schema definition

createdstring · date-timeRead-onlyOptional

closedstring · date-timeOptional

taskSummarystringRequired

onSiteContactNotesstringOptional

contactNumberstringOptionalDefault: 718-395-3620

contextstringRequired

tasksstring[] · min: 1Optional

eventsstring[]Optional

toolsstring[]Optional

checkliststring[]Optional

Responses

200

successful operation

application/json

400

Invalid status value

application/json

post

/service-requests

HTTPcURLJavaScriptPython

POST /service-requests HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 401

{
  "location": {
    "project": "text",
    "site": "text",
    "system": "text"
  },
  "closed": "2025-12-19T20:43:41.292Z",
  "siteVisitWindow": {
    "start": "2025-12-19T20:43:41.292Z",
    "end": "2025-12-19T20:43:41.292Z"
  },
  "taskSummary": "text",
  "onSiteContactNotes": "text",
  "contactNumber": "718-395-3620",
  "context": "text",
  "tasks": [
    "text"
  ],
  "events": [
    "text"
  ],
  "tools": [
    "text"
  ],
  "information": [
    {
      "text": "text",
      "link": "text"
    }
  ],
  "checklist": [
    "text"
  ]
}

{}

Get serviceRequest details

get

Gets the details for the specified serviceRequest

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

serviceRequestIdstringRequired

The serviceRequest ID

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/service-requests/{serviceRequestId}

HTTPcURLJavaScriptPython

GET /service-requests/{serviceRequestId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "serviceRequest": {
    "location": {
      "project": "text",
      "site": "text",
      "system": "text"
    },
    "created": "2025-12-19T20:43:41.292Z",
    "closed": "2025-12-19T20:43:41.292Z",
    "siteVisitWindow": {
      "start": "2025-12-19T20:43:41.292Z",
      "end": "2025-12-19T20:43:41.292Z"
    },
    "taskSummary": "text",
    "onSiteContactNotes": "text",
    "contactNumber": "718-395-3620",
    "context": "text",
    "tasks": [
      "text"
    ],
    "events": [
      "text"
    ],
    "tools": [
      "text"
    ],
    "information": [
      {
        "text": "text",
        "link": "text"
      }
    ],
    "checklist": [
      "text"
    ]
  }
}

Update an existing serviceRequest

put

Update an existing serviceRequest

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

serviceRequestIdstringRequired

The serviceRequest ID

Body

application/json

Refer to the /schemas/service-request endpoint for the full JSON Schema definition

createdstring · date-timeRead-onlyOptional

closedstring · date-timeOptional

taskSummarystringRequired

onSiteContactNotesstringOptional

contactNumberstringOptionalDefault: 718-395-3620

contextstringRequired

tasksstring[] · min: 1Optional

eventsstring[]Optional

toolsstring[]Optional

checkliststring[]Optional

Responses

200

successful operation

application/json

400

Invalid status value

application/json

put

/service-requests/{serviceRequestId}

HTTPcURLJavaScriptPython

PUT /service-requests/{serviceRequestId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 401

{
  "location": {
    "project": "text",
    "site": "text",
    "system": "text"
  },
  "closed": "2025-12-19T20:43:41.292Z",
  "siteVisitWindow": {
    "start": "2025-12-19T20:43:41.292Z",
    "end": "2025-12-19T20:43:41.292Z"
  },
  "taskSummary": "text",
  "onSiteContactNotes": "text",
  "contactNumber": "718-395-3620",
  "context": "text",
  "tasks": [
    "text"
  ],
  "events": [
    "text"
  ],
  "tools": [
    "text"
  ],
  "information": [
    {
      "text": "text",
      "link": "text"
    }
  ],
  "checklist": [
    "text"
  ]
}

{
  "serviceRequest": {
    "location": {
      "project": "text",
      "site": "text",
      "system": "text"
    },
    "created": "2025-12-19T20:43:41.292Z",
    "closed": "2025-12-19T20:43:41.292Z",
    "siteVisitWindow": {
      "start": "2025-12-19T20:43:41.292Z",
      "end": "2025-12-19T20:43:41.292Z"
    },
    "taskSummary": "text",
    "onSiteContactNotes": "text",
    "contactNumber": "718-395-3620",
    "context": "text",
    "tasks": [
      "text"
    ],
    "events": [
      "text"
    ],
    "tools": [
      "text"
    ],
    "information": [
      {
        "text": "text",
        "link": "text"
      }
    ],
    "checklist": [
      "text"
    ]
  }
}

Deletes an existing serviceRequest

delete

Deletes an existing serviceRequest

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

serviceRequestIdstringRequired

The serviceRequest ID

Responses

200

successful operation

application/json

400

Invalid status value

application/json

delete

/service-requests/{serviceRequestId}

HTTPcURLJavaScriptPython

DELETE /service-requests/{serviceRequestId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{}