Mun REST
  1. Municipal
Mun REST
  • Municipal
    • Get resources for this service.
      GET
    • call the AddAoMRoundLogs operation.
      POST
    • call the AddAoMWorksheetLogs operation.
      POST
    • call the AddSiteAttachment operation.
      POST
    • call the AddSiteContact operation.
      POST
    • call the AddSiteLog operation.
      POST
    • call the AddSiteServiceItem operation.
      POST
    • call the AddSiteServiceItemRoundSchedule operation.
      POST
    • call the AddSiteServiceNotification operation.
      POST
    • call the AddWorksheetAttachment operation.
      POST
    • call the AddWorksheetNotes operation.
      POST
    • call the CancelWorksheet operation.
      POST
    • call the CreateWorksheet operation.
      POST
    • call the DeleteSiteContact operation.
      POST
    • call the DeleteSiteServiceItem operation.
      POST
    • call the DeleteSiteServiceItemRoundSchedule operation.
      POST
    • call the GetAccountSiteId operation.
      POST
    • call the GetActiveAddresses operation.
      POST
    • call the GetAddresses operation.
      POST
    • call the GetAddressesByCoordinatesRadius operation.
      POST
    • call the GetCollectionByUprnAndDate operation.
      POST
    • call the GetCollectionByUprnAndDatePlus operation.
      POST
    • call the GetCollectionSlots operation.
      POST
    • call the GetFullSiteCollections operation.
      POST
    • call the GetFullWorksheetDetails operation.
      POST
    • call the GetInCabLogs operation.
      POST
    • call the GetLogsSearch operation.
      POST
    • call the GetNotifications operation.
      POST
    • call the GetServices operation.
      POST
    • call the GetServiceItems operation.
      POST
    • call the GetSites operation.
      POST
    • call the GetSiteAttachments operation.
      POST
    • call the GetSiteAvailableRounds operation.
      POST
    • call the GetSiteCollections operation.
      POST
    • call the GetSiteCollectionExtraDetails operation.
      POST
    • call the GetSiteContacts operation.
      POST
    • call the GetSiteContracts operation.
      POST
    • call the GetSiteFlags operation.
      POST
    • call the GetSiteId operation.
      POST
    • call the GetSiteIncidents operation.
      POST
    • call the GetSiteInfo operation.
      POST
    • call the GetSiteLogs operation.
      POST
    • call the GetSiteNotifications operation.
      POST
    • call the GetSiteServiceItemRoundSchedules operation.
      POST
    • call the GetSiteWorksheets operation.
      POST
    • call the GetStreets operation.
      POST
    • call the GetWalkNumbers operation.
      POST
    • call the GetWorkflowStatusAndEvents operation.
      POST
    • call the GetWorksheetsByReference operation.
      POST
    • call the GetWorksheetAttachments operation.
      POST
    • call the GetWorksheetChargeMatrix operation.
      POST
    • call the GetWorksheetDetails operation.
      POST
    • call the GetWorksheetDetailEvents operation.
      POST
    • call the GetWorksheetDetailExtraInfoFields operation.
      POST
    • call the GetWorksheetDetailNotes operation.
      POST
    • call the GetWorksheetDetailServiceItems operation.
      POST
    • call the GetWorksheetExtraInfoFields operation.
      POST
    • call the GetWorksheetRoles operation.
      POST
    • call the GetWorksheetServiceItems operation.
      POST
    • call the HelloWorld operation.
      POST
    • call the ProgressWorkflow operation.
      POST
    • call the RaiseCancelWorksheetRequest operation.
      POST
    • call the UpdateSiteContact operation.
      POST
    • call the UpdateSiteServiceItem operation.
      POST
    • call the UpdateSiteServiceNotification operation.
      POST
    • call the UpdateWorkflowEventDate operation.
      POST
    • call the UpdateWorksheet operation.
      POST
  1. Municipal

call the CreateWorksheet operation.

POST
/createworksheet
wsdemo-merge-uat-rest
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/createworksheet' \
--header 'Content-Type: application/json' \
--header 'X-DreamFactory-API-Key;' \
--data-raw '{
    "worksheetInput": {
        "Uprn": "string",
        "AccountSiteId": "string",
        "Usrn": "string",
        "ServiceId": "string",
        "WorksheetReference": "string",
        "WorksheetMessage": "string",
        "WorkLocationAddress": "string",
        "WorkLocationName": "string",
        "WorkLocationLatitude": "string",
        "WorkLocationLongitude": "string",
        "WorkLocationNorthing": "string",
        "WorkLocationEasting": "string",
        "WorksheetStartDate": "string",
        "WorksheetDueDate": "string",
        "ServiceItemInputs": {
            "ServiceItemInput": {
                "ServiceItemId": 0,
                "ServiceItemName": "string",
                "ServiceItemQuantity": 0
            }
        },
        "ServicePropertyInputs": {
            "ServicePropertyInput": {
                "ServicePropertyId": 0,
                "ServicePropertyValue": "string"
            }
        },
        "AdHocRoundInstanceId": "string",
        "RoleId": 0,
        "RoleName": "string"
    }
}'
Response Response Example
200 - Example 1
{
    "WorksheetResponse": {
        "anyType": null
    }
}

Request

Authorization
API Key
Add parameter in header
X-DreamFactory-API-Key
Example:
X-DreamFactory-API-Key: ********************
or
Body Params application/json
worksheetInput
object (CreateWorksheetInput) 
optional
Uprn
string 
optional
string
AccountSiteId
string 
optional
string
Usrn
string 
optional
string
ServiceId
string 
optional
string
WorksheetReference
string 
optional
string
WorksheetMessage
string 
optional
string
WorkLocationAddress
string 
optional
string
WorkLocationName
string 
optional
string
WorkLocationLatitude
string 
optional
string
WorkLocationLongitude
string 
optional
string
WorkLocationNorthing
string 
optional
string
WorkLocationEasting
string 
optional
string
WorksheetStartDate
string 
optional
string
WorksheetDueDate
string 
optional
string
ServiceItemInputs
object (ArrayOfServiceItemInput) 
optional
ServicePropertyInputs
object (ArrayOfServicePropertyInput) 
optional
AdHocRoundInstanceId
string 
optional
string
RoleId
number <int32>
optional
signed 32-bit integer
RoleName
string 
optional
string
Examples

Responses

🟢200OK
application/json
CreateWorksheetResponse Response
Body
WorksheetResponse
object (ArrayOfAnyType) 
optional
anyType
optional
any type
🔴500Server Error
Modified at 2025-06-13 09:57:01
Previous
call the CancelWorksheet operation.
Next
call the DeleteSiteContact operation.
Built with