POST API/ServiceRequest/ServiceRequestsList

Get list of service requests by Created Time

Request Information

URI Parameters

None.

Body Parameters

Created Time range

Name	Description	Type	Additional information
StartDate	Start Date	date	Required
EndDate	End Date	date	Required

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2025-04-29T18:07:30.355365+01:00",
  "EndDate": "2025-04-29T18:07:30.355365+01:00"
}

application/xml, text/xml

Sample:

<TimeRange xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StartDate>2025-04-29T18:07:30.355365+01:00</StartDate>
  <EndDate>2025-04-29T18:07:30.355365+01:00</EndDate>
</TimeRange>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TimeRange'.

Response Information

Resource Description

List of service requests with associated time range

Collection of ServiceRequest

Name	Description	Type	Additional information
EnquiryID	The EnquiryID (Leave blank when importing for CMS generated ID)	string	String length: inclusive between 0 and 50
ServiceType	Service type	string	String length: inclusive between 0 and 150
EnquiryDetails	Enquiry Details	string	String length: inclusive between 0 and 300
CreatedOnUtc	Date of creation (Leave blank when importing for auto generated)	date	None.
Status	Service Request Status (Letters can be found from /ServiceRequest/StatusList	string	Required String length: inclusive between 0 and 1
DateStarted	Date Started, if applicable	date	None.
ActionsTaken	Actions Taken	string	String length: inclusive between 0 and 300
NextDeliveryDate	Next delivery date, if applicable	date	None.
Sent	Sent date, if applicable	date	None.
Quantity	Quantity	integer	None.
CompletedDate	Completion date, if applicable	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "EnquiryID": "sample string 1",
    "ServiceType": "sample string 2",
    "EnquiryDetails": "sample string 3",
    "CreatedOnUtc": "2025-04-29T18:07:30.355365+01:00",
    "Status": "sample string 4",
    "DateStarted": "2025-04-29T18:07:30.355365+01:00",
    "ActionsTaken": "sample string 5",
    "NextDeliveryDate": "2025-04-29T18:07:30.355365+01:00",
    "Sent": "2025-04-29T18:07:30.355365+01:00",
    "Quantity": 1,
    "CompletedDate": "2025-04-29T18:07:30.355365+01:00"
  },
  {
    "EnquiryID": "sample string 1",
    "ServiceType": "sample string 2",
    "EnquiryDetails": "sample string 3",
    "CreatedOnUtc": "2025-04-29T18:07:30.355365+01:00",
    "Status": "sample string 4",
    "DateStarted": "2025-04-29T18:07:30.355365+01:00",
    "ActionsTaken": "sample string 5",
    "NextDeliveryDate": "2025-04-29T18:07:30.355365+01:00",
    "Sent": "2025-04-29T18:07:30.355365+01:00",
    "Quantity": 1,
    "CompletedDate": "2025-04-29T18:07:30.355365+01:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfServiceRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ServiceRequest>
    <EnquiryID>sample string 1</EnquiryID>
    <ServiceType>sample string 2</ServiceType>
    <EnquiryDetails>sample string 3</EnquiryDetails>
    <CreatedOnUtc>2025-04-29T18:07:30.355365+01:00</CreatedOnUtc>
    <Status>sample string 4</Status>
    <DateStarted>2025-04-29T18:07:30.355365+01:00</DateStarted>
    <ActionsTaken>sample string 5</ActionsTaken>
    <NextDeliveryDate>2025-04-29T18:07:30.355365+01:00</NextDeliveryDate>
    <Sent>2025-04-29T18:07:30.355365+01:00</Sent>
    <Quantity>1</Quantity>
    <CompletedDate>2025-04-29T18:07:30.355365+01:00</CompletedDate>
  </ServiceRequest>
  <ServiceRequest>
    <EnquiryID>sample string 1</EnquiryID>
    <ServiceType>sample string 2</ServiceType>
    <EnquiryDetails>sample string 3</EnquiryDetails>
    <CreatedOnUtc>2025-04-29T18:07:30.355365+01:00</CreatedOnUtc>
    <Status>sample string 4</Status>
    <DateStarted>2025-04-29T18:07:30.355365+01:00</DateStarted>
    <ActionsTaken>sample string 5</ActionsTaken>
    <NextDeliveryDate>2025-04-29T18:07:30.355365+01:00</NextDeliveryDate>
    <Sent>2025-04-29T18:07:30.355365+01:00</Sent>
    <Quantity>1</Quantity>
    <CompletedDate>2025-04-29T18:07:30.355365+01:00</CompletedDate>
  </ServiceRequest>
</ArrayOfServiceRequest>