POST api/Blackout

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
id	integer	None.
jobId	integer	None.
locationId	integer	None.
jobStatusId	integer	None.
statusName	string	None.
isService	boolean	None.
isJob	boolean	None.
isResidential	boolean	None.
startTime	date	None.
endTime	date	None.
visitNote	string	None.
confirmationNumber	string	None.
permitNumber	string	None.
visitNumber	integer	None.
visitNumberString	string	None.
jobNumber	integer	None.
jobNumberString	string	None.
jobNumberTypePrefix	string	None.
joinedVisitNumberString	string	None.
assignedUsers	Collection of UserGrid	None.
locationName	string	None.
clientName	string	None.
clientId	integer	None.
conflictOverride	boolean	None.
previousAddressString	string	None.
nextAddressString	string	None.
quoteItems	Collection of QuoteItem	None.
jobItems	Collection of QuoteItem	None.
hasNotes	boolean	None.
quoteVersionNumber	integer	None.
isLatestVersion	boolean	None.
convertedToVisitId	integer	None.
convertedToJobNumber	integer	None.
convertedToJobVisitNumber	integer	None.
convertedJoinedVisitNumberString	string	None.
jobAmount	decimal number	None.
isScheduled	boolean	None.
fullVisitWithVersionString	string	None.
createdFromQuoteVisit	integer	None.
isEmergency	boolean	None.
isHoliday	boolean	None.
invoiceId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "jobId": 1,
  "locationId": 2,
  "jobStatusId": 3,
  "statusName": "sample string 4",
  "isService": true,
  "isJob": true,
  "isResidential": true,
  "startTime": "2025-04-28T10:50:45.128245-04:00",
  "endTime": "2025-04-28T10:50:45.128245-04:00",
  "visitNote": "sample string 8",
  "confirmationNumber": "sample string 9",
  "permitNumber": "sample string 10",
  "visitNumber": 1,
  "visitNumberString": "0001",
  "jobNumber": 11,
  "jobNumberString": "00011",
  "jobNumberTypePrefix": "RS",
  "joinedVisitNumberString": "RS-00011-0001",
  "assignedUsers": [
    {
      "id": 1,
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "email": "sample string 4",
      "isActive": true,
      "roleNames": [
        "sample string 1",
        "sample string 2"
      ],
      "roleIds": [
        1,
        2
      ],
      "address1": "sample string 6",
      "address2": "sample string 7",
      "city": "sample string 8",
      "stateId": 9,
      "stateName": "sample string 10",
      "zip": "sample string 11",
      "phone": "sample string 12",
      "avatar": "sample string 13",
      "avatarContentType": "sample string 14",
      "tenantId": 1,
      "tenantName": "sample string 15",
      "whiteLabelColor": "sample string 16",
      "whiteLabelImage": "sample string 17",
      "whiteLabelImageType": "sample string 18",
      "whiteLabelIsDarkMode": true,
      "isService": true,
      "isProject": true,
      "isJob": true,
      "isQuote": true,
      "isRes": true,
      "isComm": true,
      "useHomeAddressForScheduling": true,
      "title": "sample string 27",
      "assignmentRoleId": 1,
      "sparkyLatestTimeStatusId": 1,
      "inputTimeSystemId": 1
    },
    {
      "id": 1,
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "email": "sample string 4",
      "isActive": true,
      "roleNames": [
        "sample string 1",
        "sample string 2"
      ],
      "roleIds": [
        1,
        2
      ],
      "address1": "sample string 6",
      "address2": "sample string 7",
      "city": "sample string 8",
      "stateId": 9,
      "stateName": "sample string 10",
      "zip": "sample string 11",
      "phone": "sample string 12",
      "avatar": "sample string 13",
      "avatarContentType": "sample string 14",
      "tenantId": 1,
      "tenantName": "sample string 15",
      "whiteLabelColor": "sample string 16",
      "whiteLabelImage": "sample string 17",
      "whiteLabelImageType": "sample string 18",
      "whiteLabelIsDarkMode": true,
      "isService": true,
      "isProject": true,
      "isJob": true,
      "isQuote": true,
      "isRes": true,
      "isComm": true,
      "useHomeAddressForScheduling": true,
      "title": "sample string 27",
      "assignmentRoleId": 1,
      "sparkyLatestTimeStatusId": 1,
      "inputTimeSystemId": 1
    }
  ],
  "locationName": "sample string 12",
  "clientName": "sample string 13",
  "clientId": 14,
  "conflictOverride": true,
  "previousAddressString": "sample string 16",
  "nextAddressString": "sample string 17",
  "quoteItems": [
    {
      "id": 1,
      "visitId": 2,
      "title": "sample string 3",
      "notes": "sample string 4",
      "pricePer": 5.0,
      "qty": 1,
      "sortOrder": 6,
      "isRemoved": true,
      "isDeleted": true,
      "createdById": 9,
      "editedById": 10,
      "lastUpdated": "2025-04-28T10:50:45.128245-04:00",
      "isChangeOrder": true,
      "completeNotes": "sample string 13",
      "isComplete": true,
      "isIncomplete": true,
      "attachments": [
        {
          "blobFileName": "sample string 1",
          "origFileName": "sample string 2",
          "blobFileType": "sample string 3",
          "b64": "sample string 4"
        },
        {
          "blobFileName": "sample string 1",
          "origFileName": "sample string 2",
          "blobFileType": "sample string 3",
          "b64": "sample string 4"
        }
      ],
      "isFromAnotherDispatch": true,
      "canEdit": true,
      "canComplete": true,
      "canDelete": true,
      "lastEditedByString": "sample string 20"
    },
    {
      "id": 1,
      "visitId": 2,
      "title": "sample string 3",
      "notes": "sample string 4",
      "pricePer": 5.0,
      "qty": 1,
      "sortOrder": 6,
      "isRemoved": true,
      "isDeleted": true,
      "createdById": 9,
      "editedById": 10,
      "lastUpdated": "2025-04-28T10:50:45.128245-04:00",
      "isChangeOrder": true,
      "completeNotes": "sample string 13",
      "isComplete": true,
      "isIncomplete": true,
      "attachments": [
        {
          "blobFileName": "sample string 1",
          "origFileName": "sample string 2",
          "blobFileType": "sample string 3",
          "b64": "sample string 4"
        },
        {
          "blobFileName": "sample string 1",
          "origFileName": "sample string 2",
          "blobFileType": "sample string 3",
          "b64": "sample string 4"
        }
      ],
      "isFromAnotherDispatch": true,
      "canEdit": true,
      "canComplete": true,
      "canDelete": true,
      "lastEditedByString": "sample string 20"
    }
  ],
  "jobItems": [
    {
      "id": 1,
      "visitId": 2,
      "title": "sample string 3",
      "notes": "sample string 4",
      "pricePer": 5.0,
      "qty": 1,
      "sortOrder": 6,
      "isRemoved": true,
      "isDeleted": true,
      "createdById": 9,
      "editedById": 10,
      "lastUpdated": "2025-04-28T10:50:45.128245-04:00",
      "isChangeOrder": true,
      "completeNotes": "sample string 13",
      "isComplete": true,
      "isIncomplete": true,
      "attachments": [
        {
          "blobFileName": "sample string 1",
          "origFileName": "sample string 2",
          "blobFileType": "sample string 3",
          "b64": "sample string 4"
        },
        {
          "blobFileName": "sample string 1",
          "origFileName": "sample string 2",
          "blobFileType": "sample string 3",
          "b64": "sample string 4"
        }
      ],
      "isFromAnotherDispatch": true,
      "canEdit": true,
      "canComplete": true,
      "canDelete": true,
      "lastEditedByString": "sample string 20"
    },
    {
      "id": 1,
      "visitId": 2,
      "title": "sample string 3",
      "notes": "sample string 4",
      "pricePer": 5.0,
      "qty": 1,
      "sortOrder": 6,
      "isRemoved": true,
      "isDeleted": true,
      "createdById": 9,
      "editedById": 10,
      "lastUpdated": "2025-04-28T10:50:45.128245-04:00",
      "isChangeOrder": true,
      "completeNotes": "sample string 13",
      "isComplete": true,
      "isIncomplete": true,
      "attachments": [
        {
          "blobFileName": "sample string 1",
          "origFileName": "sample string 2",
          "blobFileType": "sample string 3",
          "b64": "sample string 4"
        },
        {
          "blobFileName": "sample string 1",
          "origFileName": "sample string 2",
          "blobFileType": "sample string 3",
          "b64": "sample string 4"
        }
      ],
      "isFromAnotherDispatch": true,
      "canEdit": true,
      "canComplete": true,
      "canDelete": true,
      "lastEditedByString": "sample string 20"
    }
  ],
  "hasNotes": true,
  "quoteVersionNumber": 1,
  "isLatestVersion": true,
  "convertedToVisitId": 1,
  "convertedToJobNumber": 1,
  "convertedToJobVisitNumber": 1,
  "convertedJoinedVisitNumberString": "00001-0001",
  "jobAmount": 20.0,
  "isScheduled": true,
  "fullVisitWithVersionString": "RS-00011-0001v1",
  "createdFromQuoteVisit": 1,
  "isEmergency": true,
  "isHoliday": true,
  "invoiceId": 1
}

application/xml, text/xml

Sample:

<ScheduleItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WhitesElectric_BeardedBulb.DataModels">
  <assignedUsers>
    <UserGrid>
      <address1>sample string 6</address1>
      <address2>sample string 7</address2>
      <assignmentRoleId>1</assignmentRoleId>
      <avatar>sample string 13</avatar>
      <avatarContentType>sample string 14</avatarContentType>
      <city>sample string 8</city>
      <email>sample string 4</email>
      <firstName>sample string 2</firstName>
      <id>1</id>
      <inputTimeSystemId>1</inputTimeSystemId>
      <isActive>true</isActive>
      <isComm>true</isComm>
      <isJob>true</isJob>
      <isProject>true</isProject>
      <isQuote>true</isQuote>
      <isRes>true</isRes>
      <isService>true</isService>
      <lastName>sample string 3</lastName>
      <phone>sample string 12</phone>
      <roleIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </roleIds>
      <roleNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </roleNames>
      <sparkyLatestTimeStatusId>1</sparkyLatestTimeStatusId>
      <stateId>9</stateId>
      <stateName>sample string 10</stateName>
      <tenantId>1</tenantId>
      <tenantName>sample string 15</tenantName>
      <title>sample string 27</title>
      <useHomeAddressForScheduling>true</useHomeAddressForScheduling>
      <whiteLabelColor>sample string 16</whiteLabelColor>
      <whiteLabelImage>sample string 17</whiteLabelImage>
      <whiteLabelImageType>sample string 18</whiteLabelImageType>
      <whiteLabelIsDarkMode>true</whiteLabelIsDarkMode>
      <zip>sample string 11</zip>
    </UserGrid>
    <UserGrid>
      <address1>sample string 6</address1>
      <address2>sample string 7</address2>
      <assignmentRoleId>1</assignmentRoleId>
      <avatar>sample string 13</avatar>
      <avatarContentType>sample string 14</avatarContentType>
      <city>sample string 8</city>
      <email>sample string 4</email>
      <firstName>sample string 2</firstName>
      <id>1</id>
      <inputTimeSystemId>1</inputTimeSystemId>
      <isActive>true</isActive>
      <isComm>true</isComm>
      <isJob>true</isJob>
      <isProject>true</isProject>
      <isQuote>true</isQuote>
      <isRes>true</isRes>
      <isService>true</isService>
      <lastName>sample string 3</lastName>
      <phone>sample string 12</phone>
      <roleIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </roleIds>
      <roleNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </roleNames>
      <sparkyLatestTimeStatusId>1</sparkyLatestTimeStatusId>
      <stateId>9</stateId>
      <stateName>sample string 10</stateName>
      <tenantId>1</tenantId>
      <tenantName>sample string 15</tenantName>
      <title>sample string 27</title>
      <useHomeAddressForScheduling>true</useHomeAddressForScheduling>
      <whiteLabelColor>sample string 16</whiteLabelColor>
      <whiteLabelImage>sample string 17</whiteLabelImage>
      <whiteLabelImageType>sample string 18</whiteLabelImageType>
      <whiteLabelIsDarkMode>true</whiteLabelIsDarkMode>
      <zip>sample string 11</zip>
    </UserGrid>
  </assignedUsers>
  <clientId>14</clientId>
  <clientName>sample string 13</clientName>
  <confirmationNumber>sample string 9</confirmationNumber>
  <conflictOverride>true</conflictOverride>
  <convertedToJobNumber>1</convertedToJobNumber>
  <convertedToJobVisitNumber>1</convertedToJobVisitNumber>
  <convertedToVisitId>1</convertedToVisitId>
  <createdFromQuoteVisit>1</createdFromQuoteVisit>
  <endTime>2025-04-28T10:50:45.128245-04:00</endTime>
  <hasNotes>true</hasNotes>
  <id>1</id>
  <invoiceId>1</invoiceId>
  <isEmergency>true</isEmergency>
  <isHoliday>true</isHoliday>
  <isJob>true</isJob>
  <isLatestVersion>true</isLatestVersion>
  <isResidential>true</isResidential>
  <isScheduled>true</isScheduled>
  <isService>true</isService>
  <jobAmount>20</jobAmount>
  <jobId>1</jobId>
  <jobItems>
    <QuoteItem>
      <attachments>
        <BlobFile>
          <b64>sample string 4</b64>
          <blobFileName>sample string 1</blobFileName>
          <blobFileType>sample string 3</blobFileType>
          <origFileName>sample string 2</origFileName>
        </BlobFile>
        <BlobFile>
          <b64>sample string 4</b64>
          <blobFileName>sample string 1</blobFileName>
          <blobFileType>sample string 3</blobFileType>
          <origFileName>sample string 2</origFileName>
        </BlobFile>
      </attachments>
      <canComplete>true</canComplete>
      <canDelete>true</canDelete>
      <canEdit>true</canEdit>
      <completeNotes>sample string 13</completeNotes>
      <createdById>9</createdById>
      <editedById>10</editedById>
      <id>1</id>
      <isChangeOrder>true</isChangeOrder>
      <isComplete>true</isComplete>
      <isDeleted>true</isDeleted>
      <isFromAnotherDispatch>true</isFromAnotherDispatch>
      <isIncomplete>true</isIncomplete>
      <isRemoved>true</isRemoved>
      <lastEditedByString>sample string 20</lastEditedByString>
      <lastUpdated>2025-04-28T10:50:45.128245-04:00</lastUpdated>
      <notes>sample string 4</notes>
      <pricePer>5</pricePer>
      <qty>1</qty>
      <sortOrder>6</sortOrder>
      <title>sample string 3</title>
      <visitId>2</visitId>
    </QuoteItem>
    <QuoteItem>
      <attachments>
        <BlobFile>
          <b64>sample string 4</b64>
          <blobFileName>sample string 1</blobFileName>
          <blobFileType>sample string 3</blobFileType>
          <origFileName>sample string 2</origFileName>
        </BlobFile>
        <BlobFile>
          <b64>sample string 4</b64>
          <blobFileName>sample string 1</blobFileName>
          <blobFileType>sample string 3</blobFileType>
          <origFileName>sample string 2</origFileName>
        </BlobFile>
      </attachments>
      <canComplete>true</canComplete>
      <canDelete>true</canDelete>
      <canEdit>true</canEdit>
      <completeNotes>sample string 13</completeNotes>
      <createdById>9</createdById>
      <editedById>10</editedById>
      <id>1</id>
      <isChangeOrder>true</isChangeOrder>
      <isComplete>true</isComplete>
      <isDeleted>true</isDeleted>
      <isFromAnotherDispatch>true</isFromAnotherDispatch>
      <isIncomplete>true</isIncomplete>
      <isRemoved>true</isRemoved>
      <lastEditedByString>sample string 20</lastEditedByString>
      <lastUpdated>2025-04-28T10:50:45.128245-04:00</lastUpdated>
      <notes>sample string 4</notes>
      <pricePer>5</pricePer>
      <qty>1</qty>
      <sortOrder>6</sortOrder>
      <title>sample string 3</title>
      <visitId>2</visitId>
    </QuoteItem>
  </jobItems>
  <jobNumber>11</jobNumber>
  <jobStatusId>3</jobStatusId>
  <locationId>2</locationId>
  <locationName>sample string 12</locationName>
  <nextAddressString>sample string 17</nextAddressString>
  <permitNumber>sample string 10</permitNumber>
  <previousAddressString>sample string 16</previousAddressString>
  <quoteItems>
    <QuoteItem>
      <attachments>
        <BlobFile>
          <b64>sample string 4</b64>
          <blobFileName>sample string 1</blobFileName>
          <blobFileType>sample string 3</blobFileType>
          <origFileName>sample string 2</origFileName>
        </BlobFile>
        <BlobFile>
          <b64>sample string 4</b64>
          <blobFileName>sample string 1</blobFileName>
          <blobFileType>sample string 3</blobFileType>
          <origFileName>sample string 2</origFileName>
        </BlobFile>
      </attachments>
      <canComplete>true</canComplete>
      <canDelete>true</canDelete>
      <canEdit>true</canEdit>
      <completeNotes>sample string 13</completeNotes>
      <createdById>9</createdById>
      <editedById>10</editedById>
      <id>1</id>
      <isChangeOrder>true</isChangeOrder>
      <isComplete>true</isComplete>
      <isDeleted>true</isDeleted>
      <isFromAnotherDispatch>true</isFromAnotherDispatch>
      <isIncomplete>true</isIncomplete>
      <isRemoved>true</isRemoved>
      <lastEditedByString>sample string 20</lastEditedByString>
      <lastUpdated>2025-04-28T10:50:45.128245-04:00</lastUpdated>
      <notes>sample string 4</notes>
      <pricePer>5</pricePer>
      <qty>1</qty>
      <sortOrder>6</sortOrder>
      <title>sample string 3</title>
      <visitId>2</visitId>
    </QuoteItem>
    <QuoteItem>
      <attachments>
        <BlobFile>
          <b64>sample string 4</b64>
          <blobFileName>sample string 1</blobFileName>
          <blobFileType>sample string 3</blobFileType>
          <origFileName>sample string 2</origFileName>
        </BlobFile>
        <BlobFile>
          <b64>sample string 4</b64>
          <blobFileName>sample string 1</blobFileName>
          <blobFileType>sample string 3</blobFileType>
          <origFileName>sample string 2</origFileName>
        </BlobFile>
      </attachments>
      <canComplete>true</canComplete>
      <canDelete>true</canDelete>
      <canEdit>true</canEdit>
      <completeNotes>sample string 13</completeNotes>
      <createdById>9</createdById>
      <editedById>10</editedById>
      <id>1</id>
      <isChangeOrder>true</isChangeOrder>
      <isComplete>true</isComplete>
      <isDeleted>true</isDeleted>
      <isFromAnotherDispatch>true</isFromAnotherDispatch>
      <isIncomplete>true</isIncomplete>
      <isRemoved>true</isRemoved>
      <lastEditedByString>sample string 20</lastEditedByString>
      <lastUpdated>2025-04-28T10:50:45.128245-04:00</lastUpdated>
      <notes>sample string 4</notes>
      <pricePer>5</pricePer>
      <qty>1</qty>
      <sortOrder>6</sortOrder>
      <title>sample string 3</title>
      <visitId>2</visitId>
    </QuoteItem>
  </quoteItems>
  <quoteVersionNumber>1</quoteVersionNumber>
  <startTime>2025-04-28T10:50:45.128245-04:00</startTime>
  <statusName>sample string 4</statusName>
  <visitNote>sample string 8</visitNote>
  <visitNumber>1</visitNumber>
</ScheduleItem>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.