POST api/ServiceTicketDispatch

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
DispatchId	Sedona internal autonumber for the Dispatch record (SV_Service_Ticket_Dispatch table)	integer	Required
ServiceTicketId	Sedona internal autonumber for the Service Ticket record (SV_Service_Ticket table)	integer	None.
ServiceTechCode	Employee_Code from SY_Employee table; cannot change the Service Tech (must cancel and add new)	string	None.
ResolutionCode	Value from SV_Resolution table; defaults to N/A if not supplied; Required if DepartureTime is set	string	String length: inclusive between 0 and 25
ResolutionNote	Optional note that gets added to Service Ticket Notes upon resolution (do not set unless ResolvesTicket is true), limited to 1024 characters	string	String length: inclusive between 0 and 1024
ResolutionAccessLevel	Access Level for ResolutionNote; allowed values: 1 = viewed by all, including customers, 2 = viewed by office users, 3 = highest level of security; Defaults to 2	integer	None.
ScheduleTime	Scheduled date/time for the apppointment; for example, "2015-01-01 08:00:00"	date	None.
ScheduleTimeUtc	Only used when useUtcOffset is set to "1" in the web.config file	date	None.
DispatchTime	Actual dispatch date/time; for example, "2015-01-01 13:00:00"	date	None.
ArrivalTime	Actual arrival date/time; for example, "2015-01-01 14:00:00"; updates Ticket Status to "IP"	date	None.
DepartureTime	Actual departure date/time; for example, "2015-01-01 15:00:00"; Required if ResolutionCode is set; GoBack or ResolvesTicket must be true	date	None.
EstimatedLength	Estimated length of the appointment in minutes (i.e. 30, 60, etc.), zero if not supplied	integer	None.
ResolvesTicket	Does the dispatch resolve the service ticket? Defaults to false is not supplied; if DepartureTime is set and this is the only Dispatch record, either ResolvesTicket or GoBack must be true; updates Ticket Status to "RS"	boolean	None.
GoBack	Does a technician need to return? Defaults to false is not supplied; if DepartureTime is set and this is the only Dispatch record, either ResolvesTicket or GoBack must be true; updates Ticket Status to "GB"	boolean	None.
UserCode	The user making this change; defaults to UserCode value from config file if not set explicitly	string	String length: inclusive between 0 and 50
IsFirm	Defaults to False if not supplied	boolean	None.
SiteName	Business name for the AR_Customer_Site table	string	None.
Address	Full Site Address (address1 city, state zip)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DispatchId": 1,
  "ServiceTicketId": 1,
  "ServiceTechCode": "sample string 2",
  "ResolutionCode": "sample string 3",
  "ResolutionNote": "sample string 4",
  "ResolutionAccessLevel": 1,
  "ScheduleTime": "2024-10-22T15:33:41.3613794-05:00",
  "ScheduleTimeUtc": "2024-10-22T15:33:41.3613794-05:00",
  "DispatchTime": "2024-10-22T15:33:41.3613794-05:00",
  "ArrivalTime": "2024-10-22T15:33:41.3613794-05:00",
  "DepartureTime": "2024-10-22T15:33:41.3613794-05:00",
  "EstimatedLength": 1,
  "ResolvesTicket": true,
  "GoBack": true,
  "UserCode": "sample string 5",
  "IsFirm": true,
  "SiteName": "sample string 6",
  "Address": "sample string 7"
}

application/xml, text/xml

Sample:

<ServiceTicketDispatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <Address>sample string 7</Address>
  <ArrivalTime>2024-10-22T15:33:41.3613794-05:00</ArrivalTime>
  <DepartureTime>2024-10-22T15:33:41.3613794-05:00</DepartureTime>
  <DispatchId>1</DispatchId>
  <DispatchTime>2024-10-22T15:33:41.3613794-05:00</DispatchTime>
  <EstimatedLength>1</EstimatedLength>
  <GoBack>true</GoBack>
  <IsFirm>true</IsFirm>
  <ResolutionAccessLevel>1</ResolutionAccessLevel>
  <ResolutionCode>sample string 3</ResolutionCode>
  <ResolutionNote>sample string 4</ResolutionNote>
  <ResolvesTicket>true</ResolvesTicket>
  <ScheduleTime>2024-10-22T15:33:41.3613794-05:00</ScheduleTime>
  <ScheduleTimeUtc xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-10-22T20:33:41.3613794Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-300</d2p1:OffsetMinutes>
  </ScheduleTimeUtc>
  <ServiceTechCode>sample string 2</ServiceTechCode>
  <ServiceTicketId>1</ServiceTicketId>
  <SiteName>sample string 6</SiteName>
  <UserCode>sample string 5</UserCode>
</ServiceTicketDispatch>

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

Response Information

Resource Description

ServiceTicketDispatch

Name	Description	Type	Additional information
DispatchId	Sedona internal autonumber for the Dispatch record (SV_Service_Ticket_Dispatch table)	integer	Required
ServiceTicketId	Sedona internal autonumber for the Service Ticket record (SV_Service_Ticket table)	integer	None.
ServiceTechCode	Employee_Code from SY_Employee table; cannot change the Service Tech (must cancel and add new)	string	None.
ResolutionCode	Value from SV_Resolution table; defaults to N/A if not supplied; Required if DepartureTime is set	string	String length: inclusive between 0 and 25
ResolutionNote	Optional note that gets added to Service Ticket Notes upon resolution (do not set unless ResolvesTicket is true), limited to 1024 characters	string	String length: inclusive between 0 and 1024
ResolutionAccessLevel	Access Level for ResolutionNote; allowed values: 1 = viewed by all, including customers, 2 = viewed by office users, 3 = highest level of security; Defaults to 2	integer	None.
ScheduleTime	Scheduled date/time for the apppointment; for example, "2015-01-01 08:00:00"	date	None.
ScheduleTimeUtc	Only used when useUtcOffset is set to "1" in the web.config file	date	None.
DispatchTime	Actual dispatch date/time; for example, "2015-01-01 13:00:00"	date	None.
ArrivalTime	Actual arrival date/time; for example, "2015-01-01 14:00:00"; updates Ticket Status to "IP"	date	None.
DepartureTime	Actual departure date/time; for example, "2015-01-01 15:00:00"; Required if ResolutionCode is set; GoBack or ResolvesTicket must be true	date	None.
EstimatedLength	Estimated length of the appointment in minutes (i.e. 30, 60, etc.), zero if not supplied	integer	None.
ResolvesTicket	Does the dispatch resolve the service ticket? Defaults to false is not supplied; if DepartureTime is set and this is the only Dispatch record, either ResolvesTicket or GoBack must be true; updates Ticket Status to "RS"	boolean	None.
GoBack	Does a technician need to return? Defaults to false is not supplied; if DepartureTime is set and this is the only Dispatch record, either ResolvesTicket or GoBack must be true; updates Ticket Status to "GB"	boolean	None.
UserCode	The user making this change; defaults to UserCode value from config file if not set explicitly	string	String length: inclusive between 0 and 50
IsFirm	Defaults to False if not supplied	boolean	None.
SiteName	Business name for the AR_Customer_Site table	string	None.
Address	Full Site Address (address1 city, state zip)	string	None.

Response Formats

application/json, text/json

Sample:

{
  "DispatchId": 1,
  "ServiceTicketId": 1,
  "ServiceTechCode": "sample string 2",
  "ResolutionCode": "sample string 3",
  "ResolutionNote": "sample string 4",
  "ResolutionAccessLevel": 1,
  "ScheduleTime": "2024-10-22T15:33:41.3770072-05:00",
  "ScheduleTimeUtc": "2024-10-22T15:33:41.3770072-05:00",
  "DispatchTime": "2024-10-22T15:33:41.3770072-05:00",
  "ArrivalTime": "2024-10-22T15:33:41.3770072-05:00",
  "DepartureTime": "2024-10-22T15:33:41.3770072-05:00",
  "EstimatedLength": 1,
  "ResolvesTicket": true,
  "GoBack": true,
  "UserCode": "sample string 5",
  "IsFirm": true,
  "SiteName": "sample string 6",
  "Address": "sample string 7"
}

application/xml, text/xml

Sample:

<ServiceTicketDispatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <Address>sample string 7</Address>
  <ArrivalTime>2024-10-22T15:33:41.3770072-05:00</ArrivalTime>
  <DepartureTime>2024-10-22T15:33:41.3770072-05:00</DepartureTime>
  <DispatchId>1</DispatchId>
  <DispatchTime>2024-10-22T15:33:41.3770072-05:00</DispatchTime>
  <EstimatedLength>1</EstimatedLength>
  <GoBack>true</GoBack>
  <IsFirm>true</IsFirm>
  <ResolutionAccessLevel>1</ResolutionAccessLevel>
  <ResolutionCode>sample string 3</ResolutionCode>
  <ResolutionNote>sample string 4</ResolutionNote>
  <ResolvesTicket>true</ResolvesTicket>
  <ScheduleTime>2024-10-22T15:33:41.3770072-05:00</ScheduleTime>
  <ScheduleTimeUtc xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-10-22T20:33:41.3770072Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-300</d2p1:OffsetMinutes>
  </ScheduleTimeUtc>
  <ServiceTechCode>sample string 2</ServiceTechCode>
  <ServiceTicketId>1</ServiceTicketId>
  <SiteName>sample string 6</SiteName>
  <UserCode>sample string 5</UserCode>
</ServiceTicketDispatch>