POST api/permits/CreatePermit

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PermitNumber	string	None.
Token	string	None.
PermitTypeId	integer	None.
CompanyId	integer	None.
ContactId	integer	None.
CompanyName	string	None.
UtilityOwnerId	integer	None.
ProjectTypes	integer	None.
EncroachmentTypes	Collection of integer	None.
EffectiveDate	date	None.
ExpirationDate	date	None.
Purpose	string	None.
Comments	string	None.
GrantedToText	string	None.
PermitNumberOld	string	None.
IsDraft	boolean	None.
PermitStatus	string	None.
References	Collection of ReferenceDto	None.
Locations	Collection of LocationDto	None.
Documents	Collection of DocumentDetailsDto	None.

Request Formats

application/json, text/json

Sample:

{
  "PermitNumber": "sample string 1",
  "Token": "sample string 2",
  "PermitTypeId": 1,
  "CompanyId": 1,
  "ContactId": 1,
  "CompanyName": "sample string 3",
  "UtilityOwnerId": 1,
  "ProjectTypes": 1,
  "EncroachmentTypes": [
    1,
    2
  ],
  "EffectiveDate": "2025-04-25T04:33:48.1948258-04:00",
  "ExpirationDate": "2025-04-25T04:33:48.1948258-04:00",
  "Purpose": "sample string 4",
  "Comments": "sample string 5",
  "GrantedToText": "sample string 6",
  "PermitNumberOld": "sample string 7",
  "IsDraft": true,
  "PermitStatus": "sample string 9",
  "References": [
    {
      "$id": "2",
      "ReferenceTypeId": 1,
      "ReferenceValue": "sample string 1"
    },
    {
      "$ref": "2"
    }
  ],
  "Locations": [
    {
      "$id": "3",
      "SequenceNumber": 1,
      "OccupancyTypeId": 2,
      "LocationType": "sample string 3",
      "OnStreetName": "sample string 4",
      "OnStreetCode": 1,
      "FromStreetName": "sample string 5",
      "FromStreetCode": 1,
      "FromStreetNode": 1,
      "ToStreetName": "sample string 6",
      "ToStreetCode": 1,
      "ToStreetNode": 1
    },
    {
      "$ref": "3"
    }
  ],
  "Documents": [
    {
      "$id": "4",
      "DocumentId": 1,
      "PermitNumber": "sample string 2",
      "DocumentName": "sample string 3",
      "ContentType": "sample string 4",
      "DocumentSize": 5,
      "DocumentLocation": "sample string 6",
      "DocumentTypeId": 1,
      "DocumentShortDescription": "sample string 7",
      "DocumentLongDescription": "sample string 8",
      "DocumentUploaded": "2025-04-25T04:33:48.1948258-04:00"
    },
    {
      "$ref": "4"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.