POST schedule/setAppointment

Request Information

URI Parameters

None.

Body Parameters

SchedulingInformation
NameDescriptionTypeAdditional information
ProNumber

string

None.

OrderNumber

string

None.

OrgStation

string

None.

DstStation

string

None.

Area

string

None.

BillToATNum

string

None.

ShipConsATNum

string

None.

ShipConsAddress1

string

None.

ShipConsCity

string

None.

ShipConsState

string

None.

ShipConsZip

string

None.

ShipConsPhone

string

None.

ShipConsEmail

string

None.

IsAmazon

boolean

None.

IsBeyond

boolean

None.

ShowSaturday

boolean

None.

ErrorMessage

string

None.

Appointments

Collection of AppointmentInformation

None.

Request Formats

application/json, text/json

Sample:
{
  "ProNumber": "sample string 1",
  "OrderNumber": "sample string 2",
  "OrgStation": "sample string 3",
  "DstStation": "sample string 4",
  "Area": "sample string 5",
  "BillToATNum": "sample string 6",
  "ShipConsATNum": "sample string 7",
  "ShipConsAddress1": "sample string 8",
  "ShipConsCity": "sample string 9",
  "ShipConsState": "sample string 10",
  "ShipConsZip": "sample string 11",
  "ShipConsPhone": "sample string 12",
  "ShipConsEmail": "sample string 13",
  "IsAmazon": true,
  "IsBeyond": true,
  "ShowSaturday": true,
  "ErrorMessage": "sample string 17",
  "Appointments": [
    {
      "Date": "sample string 1",
      "TimeSlots": [
        {
          "Slot": "sample string 1",
          "KeyCode": "sample string 2"
        },
        {
          "Slot": "sample string 1",
          "KeyCode": "sample string 2"
        }
      ]
    },
    {
      "Date": "sample string 1",
      "TimeSlots": [
        {
          "Slot": "sample string 1",
          "KeyCode": "sample string 2"
        },
        {
          "Slot": "sample string 1",
          "KeyCode": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<SchedulingInformation xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProNumber>sample string 1</ProNumber>
  <OrderNumber>sample string 2</OrderNumber>
  <OrgStation>sample string 3</OrgStation>
  <DstStation>sample string 4</DstStation>
  <Area>sample string 5</Area>
  <BillToATNum>sample string 6</BillToATNum>
  <ShipConsATNum>sample string 7</ShipConsATNum>
  <ShipConsAddress1>sample string 8</ShipConsAddress1>
  <ShipConsCity>sample string 9</ShipConsCity>
  <ShipConsState>sample string 10</ShipConsState>
  <ShipConsZip>sample string 11</ShipConsZip>
  <ShipConsPhone>sample string 12</ShipConsPhone>
  <ShipConsEmail>sample string 13</ShipConsEmail>
  <IsAmazon>true</IsAmazon>
  <IsBeyond>true</IsBeyond>
  <ShowSaturday>true</ShowSaturday>
  <ErrorMessage>sample string 17</ErrorMessage>
  <Appointments>
    <AppointmentInformation>
      <Date>sample string 1</Date>
      <TimeSlots>
        <TimeSlot>
          <Slot>sample string 1</Slot>
          <KeyCode>sample string 2</KeyCode>
        </TimeSlot>
        <TimeSlot>
          <Slot>sample string 1</Slot>
          <KeyCode>sample string 2</KeyCode>
        </TimeSlot>
      </TimeSlots>
    </AppointmentInformation>
    <AppointmentInformation>
      <Date>sample string 1</Date>
      <TimeSlots>
        <TimeSlot>
          <Slot>sample string 1</Slot>
          <KeyCode>sample string 2</KeyCode>
        </TimeSlot>
        <TimeSlot>
          <Slot>sample string 1</Slot>
          <KeyCode>sample string 2</KeyCode>
        </TimeSlot>
      </TimeSlots>
    </AppointmentInformation>
  </Appointments>
</SchedulingInformation>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PilotWWWResult
NameDescriptionTypeAdditional information
IsError

boolean

None.

Result

boolean

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsError": true,
  "Result": true,
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:
<PilotWWWResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsError>true</IsError>
  <Result>true</Result>
  <Message>sample string 3</Message>
</PilotWWWResult>