POST api/GetAppointment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
workOrderDetail	DSMWorkOrderDetail	None.
loginDetail	clsLoginDetail	None.
isSelfScheduling	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "workOrderDetail": {
    "SQLRefId": "sample string 1",
    "territoryId": "sample string 2",
    "workOrderId": "sample string 3",
    "latitude": 4.1,
    "longitude": 5.1,
    "serviceTimeSlot": "sample string 6",
    "serviceDate": "2025-01-04T05:59:43.9743318+00:00",
    "serviceDuration": 8,
    "serviceAddress": "sample string 9",
    "city": "sample string 10",
    "state": "sample string 11",
    "country": "sample string 12",
    "postalCode": "sample string 13",
    "planDate": [
      "2025-01-04T05:59:43.9743318+00:00",
      "2025-01-04T05:59:43.9743318+00:00"
    ],
    "planTimeSlots": [
      "sample string 1",
      "sample string 2"
    ],
    "workTeamId": [
      "sample string 1",
      "sample string 2"
    ],
    "employeeId": [
      "sample string 1",
      "sample string 2"
    ],
    "sessionID": "sample string 14",
    "serviceWorkTeamId": "sample string 15",
    "ManualWorkOrder": true,
    "IsFixedResource": true,
    "isFixedTime": true,
    "workOrderStatus": "sample string 19",
    "timeOfDay": "sample string 20",
    "dayNames": "sample string 21",
    "VisitTimeSlot": "sample string 22",
    "serviceFinishTime": "sample string 23",
    "arrivalTime": "sample string 24",
    "earlyArrivalTime": "sample string 25",
    "lateArrivalTime": "sample string 26",
    "nextAvailableTime": "sample string 27",
    "employeeSkillWeight": [
      1,
      2
    ],
    "orgId": "sample string 28",
    "timeDiff": 29,
    "inspectorId": [
      "sample string 1",
      "sample string 2"
    ],
    "serviceInspectorId": "sample string 30",
    "isSelfScheduling": true,
    "isSkipDriveTime": true,
    "OverrideConfig": true,
    "MaxAppointmentPerDay": 34,
    "IsVirtual": true
  },
  "loginDetail": {
    "sessionID": "sample string 1",
    "serverURL": "sample string 2",
    "orgID": "sample string 3",
    "userName": "sample string 4",
    "password": "sample string 5",
    "securityToken": "sample string 6",
    "connectionString": "sample string 7",
    "MetadataServerURL": "sample string 8"
  },
  "isSelfScheduling": true
}

application/xml, text/xml

Sample:

<AppointmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RouteOptimizerWebAPI.Models">
  <isSelfScheduling>true</isSelfScheduling>
  <loginDetail>
    <MetadataServerURL>sample string 8</MetadataServerURL>
    <connectionString>sample string 7</connectionString>
    <orgID>sample string 3</orgID>
    <password>sample string 5</password>
    <securityToken>sample string 6</securityToken>
    <serverURL>sample string 2</serverURL>
    <sessionID>sample string 1</sessionID>
    <userName>sample string 4</userName>
  </loginDetail>
  <workOrderDetail>
    <IsFixedResource>true</IsFixedResource>
    <IsVirtual>true</IsVirtual>
    <ManualWorkOrder>true</ManualWorkOrder>
    <MaxAppointmentPerDay>34</MaxAppointmentPerDay>
    <OverrideConfig>true</OverrideConfig>
    <SQLRefId>sample string 1</SQLRefId>
    <VisitTimeSlot>sample string 22</VisitTimeSlot>
    <arrivalTime>sample string 24</arrivalTime>
    <city>sample string 10</city>
    <country>sample string 12</country>
    <dayNames>sample string 21</dayNames>
    <earlyArrivalTime>sample string 25</earlyArrivalTime>
    <employeeId xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </employeeId>
    <employeeSkillWeight xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </employeeSkillWeight>
    <inspectorId xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </inspectorId>
    <isFixedTime>true</isFixedTime>
    <isSelfScheduling>true</isSelfScheduling>
    <isSkipDriveTime>true</isSkipDriveTime>
    <lateArrivalTime>sample string 26</lateArrivalTime>
    <latitude>4.1</latitude>
    <longitude>5.1</longitude>
    <nextAvailableTime>sample string 27</nextAvailableTime>
    <orgId>sample string 28</orgId>
    <planDate xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:dateTime>2025-01-04T05:59:43.9743318+00:00</d3p1:dateTime>
      <d3p1:dateTime>2025-01-04T05:59:43.9743318+00:00</d3p1:dateTime>
    </planDate>
    <planTimeSlots xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </planTimeSlots>
    <postalCode>sample string 13</postalCode>
    <serviceAddress>sample string 9</serviceAddress>
    <serviceDate>2025-01-04T05:59:43.9743318+00:00</serviceDate>
    <serviceDuration>8</serviceDuration>
    <serviceFinishTime>sample string 23</serviceFinishTime>
    <serviceInspectorId>sample string 30</serviceInspectorId>
    <serviceTimeSlot>sample string 6</serviceTimeSlot>
    <serviceWorkTeamId>sample string 15</serviceWorkTeamId>
    <sessionID>sample string 14</sessionID>
    <state>sample string 11</state>
    <territoryId>sample string 2</territoryId>
    <timeDiff>29</timeDiff>
    <timeOfDay>sample string 20</timeOfDay>
    <workOrderId>sample string 3</workOrderId>
    <workOrderStatus>sample string 19</workOrderStatus>
    <workTeamId xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </workTeamId>
  </workOrderDetail>
</AppointmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AppointmentResult

Name	Type	Additional information
appointmentOption	Collection of AppointmentOption	None.
success	boolean	None.
error	string	None.
sessionId	string	None.
WorkOrderId	string	None.
workOrderRefId	string	None.
LastOptionDate	date	None.
orgId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "appointmentOption": [
    {
      "workOrderRefId": "sample string 1",
      "workOrderId": "sample string 2",
      "workTeamId": "sample string 3",
      "sequence": 4,
      "serviceDate": "sample string 5",
      "serviceTime": "sample string 6",
      "serviceDateTime": "2025-01-04T05:59:43.9743318+00:00",
      "serviceTimeSlot": "sample string 8",
      "serviceDuration": 9,
      "drivingTime": "sample string 10",
      "distanceText": "sample string 11",
      "distanceValue": 12.1,
      "drivingTimeInSeconds": 13.1,
      "averageDrivingSpeed": 14.1,
      "arrivalTime": "sample string 15",
      "lateArrivalTime": "sample string 16",
      "earlyArrivalTime": "sample string 17",
      "timeOfDay": "sample string 18",
      "violation": "sample string 19",
      "serviceAddress": "sample string 20",
      "city": "sample string 21",
      "state": "sample string 22",
      "postalCode": "sample string 23",
      "geoLatitude": "sample string 24",
      "geoLongitude": "sample string 25",
      "lastLocationId": "sample string 26",
      "serviceFinishTime": "sample string 27",
      "nextavailableTime": "sample string 28",
      "actualServiceTimeSlot": "sample string 29",
      "displaySlotText": "sample string 30",
      "SkillIndex": 31,
      "earlyArrivalTime_24Hrs": "sample string 32",
      "lateArrivalTime_24Hrs": "sample string 33",
      "inspectorId": "sample string 34"
    },
    {
      "workOrderRefId": "sample string 1",
      "workOrderId": "sample string 2",
      "workTeamId": "sample string 3",
      "sequence": 4,
      "serviceDate": "sample string 5",
      "serviceTime": "sample string 6",
      "serviceDateTime": "2025-01-04T05:59:43.9743318+00:00",
      "serviceTimeSlot": "sample string 8",
      "serviceDuration": 9,
      "drivingTime": "sample string 10",
      "distanceText": "sample string 11",
      "distanceValue": 12.1,
      "drivingTimeInSeconds": 13.1,
      "averageDrivingSpeed": 14.1,
      "arrivalTime": "sample string 15",
      "lateArrivalTime": "sample string 16",
      "earlyArrivalTime": "sample string 17",
      "timeOfDay": "sample string 18",
      "violation": "sample string 19",
      "serviceAddress": "sample string 20",
      "city": "sample string 21",
      "state": "sample string 22",
      "postalCode": "sample string 23",
      "geoLatitude": "sample string 24",
      "geoLongitude": "sample string 25",
      "lastLocationId": "sample string 26",
      "serviceFinishTime": "sample string 27",
      "nextavailableTime": "sample string 28",
      "actualServiceTimeSlot": "sample string 29",
      "displaySlotText": "sample string 30",
      "SkillIndex": 31,
      "earlyArrivalTime_24Hrs": "sample string 32",
      "lateArrivalTime_24Hrs": "sample string 33",
      "inspectorId": "sample string 34"
    }
  ],
  "success": true,
  "error": "sample string 2",
  "sessionId": "sample string 3",
  "WorkOrderId": "sample string 4",
  "workOrderRefId": "sample string 5",
  "LastOptionDate": "2025-01-04T05:59:43.9743318+00:00",
  "orgId": "sample string 7"
}

application/xml, text/xml

Sample:

<AppointmentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RouteOptimizerWebAPI.Models">
  <LastOptionDate>2025-01-04T05:59:43.9743318+00:00</LastOptionDate>
  <WorkOrderId>sample string 4</WorkOrderId>
  <appointmentOption>
    <AppointmentOption>
      <SkillIndex>31</SkillIndex>
      <actualServiceTimeSlot>sample string 29</actualServiceTimeSlot>
      <arrivalTime>sample string 15</arrivalTime>
      <averageDrivingSpeed>14.1</averageDrivingSpeed>
      <city>sample string 21</city>
      <displaySlotText>sample string 30</displaySlotText>
      <distanceText>sample string 11</distanceText>
      <distanceValue>12.1</distanceValue>
      <drivingTime>sample string 10</drivingTime>
      <drivingTimeInSeconds>13.1</drivingTimeInSeconds>
      <earlyArrivalTime>sample string 17</earlyArrivalTime>
      <earlyArrivalTime_24Hrs>sample string 32</earlyArrivalTime_24Hrs>
      <geoLatitude>sample string 24</geoLatitude>
      <geoLongitude>sample string 25</geoLongitude>
      <inspectorId>sample string 34</inspectorId>
      <lastLocationId>sample string 26</lastLocationId>
      <lateArrivalTime>sample string 16</lateArrivalTime>
      <lateArrivalTime_24Hrs>sample string 33</lateArrivalTime_24Hrs>
      <nextavailableTime>sample string 28</nextavailableTime>
      <postalCode>sample string 23</postalCode>
      <sequence>4</sequence>
      <serviceAddress>sample string 20</serviceAddress>
      <serviceDate>sample string 5</serviceDate>
      <serviceDateTime>2025-01-04T05:59:43.9743318+00:00</serviceDateTime>
      <serviceDuration>9</serviceDuration>
      <serviceFinishTime>sample string 27</serviceFinishTime>
      <serviceTime>sample string 6</serviceTime>
      <serviceTimeSlot>sample string 8</serviceTimeSlot>
      <state>sample string 22</state>
      <timeOfDay>sample string 18</timeOfDay>
      <violation>sample string 19</violation>
      <workOrderId>sample string 2</workOrderId>
      <workOrderRefId>sample string 1</workOrderRefId>
      <workTeamId>sample string 3</workTeamId>
    </AppointmentOption>
    <AppointmentOption>
      <SkillIndex>31</SkillIndex>
      <actualServiceTimeSlot>sample string 29</actualServiceTimeSlot>
      <arrivalTime>sample string 15</arrivalTime>
      <averageDrivingSpeed>14.1</averageDrivingSpeed>
      <city>sample string 21</city>
      <displaySlotText>sample string 30</displaySlotText>
      <distanceText>sample string 11</distanceText>
      <distanceValue>12.1</distanceValue>
      <drivingTime>sample string 10</drivingTime>
      <drivingTimeInSeconds>13.1</drivingTimeInSeconds>
      <earlyArrivalTime>sample string 17</earlyArrivalTime>
      <earlyArrivalTime_24Hrs>sample string 32</earlyArrivalTime_24Hrs>
      <geoLatitude>sample string 24</geoLatitude>
      <geoLongitude>sample string 25</geoLongitude>
      <inspectorId>sample string 34</inspectorId>
      <lastLocationId>sample string 26</lastLocationId>
      <lateArrivalTime>sample string 16</lateArrivalTime>
      <lateArrivalTime_24Hrs>sample string 33</lateArrivalTime_24Hrs>
      <nextavailableTime>sample string 28</nextavailableTime>
      <postalCode>sample string 23</postalCode>
      <sequence>4</sequence>
      <serviceAddress>sample string 20</serviceAddress>
      <serviceDate>sample string 5</serviceDate>
      <serviceDateTime>2025-01-04T05:59:43.9743318+00:00</serviceDateTime>
      <serviceDuration>9</serviceDuration>
      <serviceFinishTime>sample string 27</serviceFinishTime>
      <serviceTime>sample string 6</serviceTime>
      <serviceTimeSlot>sample string 8</serviceTimeSlot>
      <state>sample string 22</state>
      <timeOfDay>sample string 18</timeOfDay>
      <violation>sample string 19</violation>
      <workOrderId>sample string 2</workOrderId>
      <workOrderRefId>sample string 1</workOrderRefId>
      <workTeamId>sample string 3</workTeamId>
    </AppointmentOption>
  </appointmentOption>
  <error>sample string 2</error>
  <orgId>sample string 7</orgId>
  <sessionId>sample string 3</sessionId>
  <success>true</success>
  <workOrderRefId>sample string 5</workOrderRefId>
</AppointmentResult>