POST api/Sites

Request Information

URI Parameters

None.

Body Parameters

SiteDto
NameDescriptionTypeAdditional information
ClientID

integer

Required
Description

string

Required

String length: inclusive between 0 and 100
Address1

string

Required

String length: inclusive between 0 and 100
Address2

string

String length: inclusive between 0 and 100
Contact

string

String length: inclusive between 0 and 100
Phone

string

String length: inclusive between 0 and 25
Fax

string

String length: inclusive between 0 and 25
Mobile

string

String length: inclusive between 0 and 25
Notes

string

None.
Email

string

String length: inclusive between 0 and 50
Suburb

string

Required

String length: inclusive between 0 and 50
Postcode

string

String length: inclusive between 0 and 5
State

string

String length: inclusive between 0 and 3
Country

string

String length: inclusive between 0 and 3
CarrierSiteID

string

String length: inclusive between 0 and 20
LocationID

integer

None.
ViperSiteID

integer

None.
PickupAllowBefore

decimal number

None.
PickupAllowAfter

decimal number

None.
DeliverAllowBefore

decimal number

None.
DeliverAllowAfter

decimal number

None.

Request Formats

application/json, text/json

Sample: 
{
  "ClientID": 1,
  "Description": "sample string 2",
  "Address1": "sample string 3",
  "Address2": "sample string 4",
  "Contact": "sample string 5",
  "Phone": "sample string 6",
  "Fax": "sample string 7",
  "Mobile": "sample string 8",
  "Notes": "sample string 9",
  "Email": "sample string 10",
  "Suburb": "sample string 11",
  "Postcode": "sample string 12",
  "State": "sample string 13",
  "Country": "sample string 14",
  "CarrierSiteID": "sample string 15",
  "LocationID": 1,
  "ViperSiteID": 16,
  "PickupAllowBefore": 1.0,
  "PickupAllowAfter": 1.0,
  "DeliverAllowBefore": 1.0,
  "DeliverAllowAfter": 1.0
}

application/xml, text/xml

Sample: 
<SiteDto xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ClientID>1</ClientID>
  <Description>sample string 2</Description>
  <Address1>sample string 3</Address1>
  <Address2>sample string 4</Address2>
  <Contact>sample string 5</Contact>
  <Phone>sample string 6</Phone>
  <Fax>sample string 7</Fax>
  <Mobile>sample string 8</Mobile>
  <Notes>sample string 9</Notes>
  <Email>sample string 10</Email>
  <Suburb>sample string 11</Suburb>
  <Postcode>sample string 12</Postcode>
  <State>sample string 13</State>
  <Country>sample string 14</Country>
  <CarrierSiteID>sample string 15</CarrierSiteID>
  <LocationID>1</LocationID>
  <ViperSiteID>16</ViperSiteID>
  <PickupAllowBefore>1</PickupAllowBefore>
  <PickupAllowAfter>1</PickupAllowAfter>
  <DeliverAllowBefore>1</DeliverAllowBefore>
  <DeliverAllowAfter>1</DeliverAllowAfter>
</SiteDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiSiteResponse
NameDescriptionTypeAdditional information
success

boolean

None.
Result

string

None.
ViperSiteID

integer

None.
CarrierID

string

None.
CarrierSiteID

string

None.
LocationID

integer

None.
Warning

string

None.
Error

string

None.
LocaleResponse

Collection of ApiLocalityResponse

None.

Response Formats

application/json, text/json

Sample: 
{
  "LocaleResponse": [
    {
      "LocationID": 1,
      "Suburb": "sample string 2",
      "State": "sample string 3",
      "Postcode": "sample string 4"
    },
    {
      "LocationID": 1,
      "Suburb": "sample string 2",
      "State": "sample string 3",
      "Postcode": "sample string 4"
    }
  ],
  "success": true,
  "Result": "sample string 2",
  "ViperSiteID": 3,
  "CarrierID": "sample string 4",
  "CarrierSiteID": "sample string 5",
  "LocationID": 1,
  "Warning": "sample string 6",
  "Error": "sample string 7"
}