POST API/JobTrak/ImportHaulageProperties

Import properties for use in haulage routes

Request Information

URI Parameters

None.

Body Parameters

Properties to import

Collection of HaulagePropertyImportItem
NameDescriptionTypeAdditional information
PropertyCode

Property Code

 string

Required
CustomerAccountNumber

The Customer Account Number

 string

Required
PropertyName

Property Name

 string

Required
Street

Street

 string

Required
Town

Town

 string

Required
Region

Region

 string

Required
County

County

 string

Required
Postcode

Postcode

 string

Required
PrimaryContactName

Primary Contact Name

 string

Required
PrimaryContactJobTitle

Primary Contact Job Title

 string

Required
PrimaryContactDepartment

Primary Contact Department

 string

Required
PrimaryContactTelephoneNumber

Primary Contact Telephone Number

 string

Required
PrimaryContactMobileNumber

Primary Contact Mobile Number

 string

Required
PrimaryContactFax

Primary Contact Fax

 string

Required
PrimaryContactEmail

Primary Contact Email

 string

Required
SecondaryContactName

Secondary Contact Name

 string

Required
SecondaryContactJobTitle

Secondary Contact Job Title

 string

Required
SecondaryContactDepartment

Secondary Contact Department

 string

Required
SecondaryContactTelephoneNumber

Secondary Contact Telephone Number

 string

Required
SecondaryContactMobileNumber

Secondary Contact Mobile Number

 string

Required
SecondaryContactFax

Secondary Contact Fax

 string

Required
SecondaryContactEmail

Secondary Contact Email

 string

Required
SpecialInstructions

Special Instructions

 string

None.
Status

Property status (A = Active, O = On-hold, C = closed)

 string

String length: inclusive between 0 and 1

Request Formats

application/json, text/json

Sample: 
[
  {
    "PropertyCode": "sample string 1",
    "CustomerAccountNumber": "sample string 2",
    "PropertyName": "sample string 3",
    "Street": "sample string 4",
    "Town": "sample string 5",
    "Region": "sample string 6",
    "County": "sample string 7",
    "Postcode": "sample string 8",
    "PrimaryContactName": "sample string 9",
    "PrimaryContactJobTitle": "sample string 10",
    "PrimaryContactDepartment": "sample string 11",
    "PrimaryContactTelephoneNumber": "sample string 12",
    "PrimaryContactMobileNumber": "sample string 13",
    "PrimaryContactFax": "sample string 14",
    "PrimaryContactEmail": "sample string 15",
    "SecondaryContactName": "sample string 16",
    "SecondaryContactJobTitle": "sample string 17",
    "SecondaryContactDepartment": "sample string 18",
    "SecondaryContactTelephoneNumber": "sample string 19",
    "SecondaryContactMobileNumber": "sample string 20",
    "SecondaryContactFax": "sample string 21",
    "SecondaryContactEmail": "sample string 22",
    "SpecialInstructions": "sample string 23",
    "Status": "sample string 24"
  },
  {
    "PropertyCode": "sample string 1",
    "CustomerAccountNumber": "sample string 2",
    "PropertyName": "sample string 3",
    "Street": "sample string 4",
    "Town": "sample string 5",
    "Region": "sample string 6",
    "County": "sample string 7",
    "Postcode": "sample string 8",
    "PrimaryContactName": "sample string 9",
    "PrimaryContactJobTitle": "sample string 10",
    "PrimaryContactDepartment": "sample string 11",
    "PrimaryContactTelephoneNumber": "sample string 12",
    "PrimaryContactMobileNumber": "sample string 13",
    "PrimaryContactFax": "sample string 14",
    "PrimaryContactEmail": "sample string 15",
    "SecondaryContactName": "sample string 16",
    "SecondaryContactJobTitle": "sample string 17",
    "SecondaryContactDepartment": "sample string 18",
    "SecondaryContactTelephoneNumber": "sample string 19",
    "SecondaryContactMobileNumber": "sample string 20",
    "SecondaryContactFax": "sample string 21",
    "SecondaryContactEmail": "sample string 22",
    "SpecialInstructions": "sample string 23",
    "Status": "sample string 24"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfHaulagePropertyImportItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <HaulagePropertyImportItem>
    <PropertyCode>sample string 1</PropertyCode>
    <CustomerAccountNumber>sample string 2</CustomerAccountNumber>
    <PropertyName>sample string 3</PropertyName>
    <Street>sample string 4</Street>
    <Town>sample string 5</Town>
    <Region>sample string 6</Region>
    <County>sample string 7</County>
    <Postcode>sample string 8</Postcode>
    <PrimaryContactName>sample string 9</PrimaryContactName>
    <PrimaryContactJobTitle>sample string 10</PrimaryContactJobTitle>
    <PrimaryContactDepartment>sample string 11</PrimaryContactDepartment>
    <PrimaryContactTelephoneNumber>sample string 12</PrimaryContactTelephoneNumber>
    <PrimaryContactMobileNumber>sample string 13</PrimaryContactMobileNumber>
    <PrimaryContactFax>sample string 14</PrimaryContactFax>
    <PrimaryContactEmail>sample string 15</PrimaryContactEmail>
    <SecondaryContactName>sample string 16</SecondaryContactName>
    <SecondaryContactJobTitle>sample string 17</SecondaryContactJobTitle>
    <SecondaryContactDepartment>sample string 18</SecondaryContactDepartment>
    <SecondaryContactTelephoneNumber>sample string 19</SecondaryContactTelephoneNumber>
    <SecondaryContactMobileNumber>sample string 20</SecondaryContactMobileNumber>
    <SecondaryContactFax>sample string 21</SecondaryContactFax>
    <SecondaryContactEmail>sample string 22</SecondaryContactEmail>
    <SpecialInstructions>sample string 23</SpecialInstructions>
    <Status>sample string 24</Status>
  </HaulagePropertyImportItem>
  <HaulagePropertyImportItem>
    <PropertyCode>sample string 1</PropertyCode>
    <CustomerAccountNumber>sample string 2</CustomerAccountNumber>
    <PropertyName>sample string 3</PropertyName>
    <Street>sample string 4</Street>
    <Town>sample string 5</Town>
    <Region>sample string 6</Region>
    <County>sample string 7</County>
    <Postcode>sample string 8</Postcode>
    <PrimaryContactName>sample string 9</PrimaryContactName>
    <PrimaryContactJobTitle>sample string 10</PrimaryContactJobTitle>
    <PrimaryContactDepartment>sample string 11</PrimaryContactDepartment>
    <PrimaryContactTelephoneNumber>sample string 12</PrimaryContactTelephoneNumber>
    <PrimaryContactMobileNumber>sample string 13</PrimaryContactMobileNumber>
    <PrimaryContactFax>sample string 14</PrimaryContactFax>
    <PrimaryContactEmail>sample string 15</PrimaryContactEmail>
    <SecondaryContactName>sample string 16</SecondaryContactName>
    <SecondaryContactJobTitle>sample string 17</SecondaryContactJobTitle>
    <SecondaryContactDepartment>sample string 18</SecondaryContactDepartment>
    <SecondaryContactTelephoneNumber>sample string 19</SecondaryContactTelephoneNumber>
    <SecondaryContactMobileNumber>sample string 20</SecondaryContactMobileNumber>
    <SecondaryContactFax>sample string 21</SecondaryContactFax>
    <SecondaryContactEmail>sample string 22</SecondaryContactEmail>
    <SpecialInstructions>sample string 23</SpecialInstructions>
    <Status>sample string 24</Status>
  </HaulagePropertyImportItem>
</ArrayOfHaulagePropertyImportItem>

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 'List`1'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.