POST API/ServiceRequest/ImportByUprn

Import a Service Request by UPPRN

Request Information

URI Parameters

None.

Body Parameters

Service Request UPRN import object

Name	Description	Type	Additional information
UPRN	UPRN to associate Service Request with	string	Required
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.

Request Formats

application/json, text/json

Sample:

{
  "UPRN": "sample string 1",
  "EnquiryID": "sample string 2",
  "ServiceType": "sample string 3",
  "EnquiryDetails": "sample string 4",
  "CreatedOnUtc": "2025-04-29T18:22:18.6807139+01:00",
  "Status": "sample string 5",
  "DateStarted": "2025-04-29T18:22:18.6807139+01:00",
  "ActionsTaken": "sample string 6",
  "NextDeliveryDate": "2025-04-29T18:22:18.6807139+01:00",
  "Sent": "2025-04-29T18:22:18.6807139+01:00",
  "Quantity": 1,
  "CompletedDate": "2025-04-29T18:22:18.6807139+01:00"
}

application/xml, text/xml

Sample:

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

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 'ServiceRequestUprnImport'.

Response Information

Resource Description

Response from the server

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.