POST API/JobTrak/ImportWasteCustomerProperties

Import Waste Customer Properties for use in Trade Routes

Request Information

URI Parameters

None.

Body Parameters

Properties to import

Collection of WasteCustomerProperty
NameDescriptionTypeAdditional information
CustomerAccountNumber

Customer Account Number

 string

Required
PropertyName

Property Name

 string

Required

String length: inclusive between 0 and 50
AddressLine1

Address Line 1 (Street name)

 string

Required

String length: inclusive between 0 and 50
AddressLine2

Address Line 2 (Region)

 string

String length: inclusive between 0 and 50
City

City

 string

String length: inclusive between 0 and 50
County

County

 string

String length: inclusive between 0 and 50
PostCode

Postal code

 string

Required

String length: inclusive between 0 and 10
Latitude

Latitude coordinates (Leave blank for auto geo-coding with Google Maps)

 decimal number

None.
Longitude

Longitude coordinates (Leave blank for auto geo-coding with Google Maps)

 decimal number

None.
PrimaryContactName

Primary Contact Name

 string

None.
PrimaryContactJobTitle

Primary Contact Job Title

 string

None.
PrimaryContactDepartment

Primary Contact Department

 string

None.
PrimaryContactTelephoneNumber

Primary Contact Telephone Number

 string

None.
PrimaryContactMobileNumber

Primary Contact Mobile Number

 string

None.
PrimaryContactFax

Primary Contact Fax

 string

None.
PrimaryContactEmail

Primary Contact Email

 string

None.
SecondaryContactName

Secondary Contact Name

 string

None.
SecondaryContactJobTitle

Secondary Contact Job Title

 string

None.
SecondaryContactDepartment

Secondary Contact Department

 string

None.
SecondaryContactTelephoneNumber

Secondary Contact Telephone Number

 string

None.
SecondaryContactMobileNumber

Secondary Contact Mobile Number

 string

None.
SecondaryContactFax

Secondary Contact Fax

 string

None.
SecondaryContactEmail

Secondary Contact Email

 string

None.
Status

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

 string

String length: inclusive between 0 and 1
SpecialInstructions

Property associated Special Instructions

 string

None.
PropertyCode

Property code

 string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

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 'WasteCustomerProperty[]'.

Response Information

Resource Description

Response from the server

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.