Authentication

Authentication

Include your API key in the Authorization header

 Authorization: Basic 985F88D4-5001-4121-A8A1-CD2262F36B1D

Available Endpoints

Test

/wssapi/v2/test

Simulates a success

Action
GET
{
    "Success": true,
    "ErrorMessage": "string"
}

Error

/wssapi/v2/error

Simulates an error

Action
GET
{
    "Success": false,
    "ErrorMessage": "An unhandled exception has occurred and been logged."
}

Locations List

/wssapi/v2/locations

Lists all entities to which you have access

Action
GET
{
    "Entities": [
        990019
    ],
    "Success": true,
    "ErrorMessage": ""
}

Location Information

/wssapi/v2/location/{entity}

Returns information about the location

Action
GET
{entity}
String value of the location entity for which to return information
        {
  "Location": {
    "Address": {
      "AddressLine1": "2727 N. Central Ave",
      "AddressLine2": "",
      "City": "phoenix",
      "Country": "",
      "County": null,
      "DestinationLatitude": 0,
      "DestinationLongitude": 0,
      "DestinationState": null,
      "FormattedAddress": null,
      "Location": {
        "Latitude": 33.4784517329009,
        "Longitude": -112.073155919474
      },
      "OriginLatitude": 0,
      "OriginLongitude": 0,
      "PostalCode": "85004",
      "State": "AZ"
    },
    "AllowsReservations": true,
    "Coupons": [     
      {
        "Description": "12 month get 2 free",
        "Instructions": ""
      },      
      {
        "Description": "10% Armed Forces Discount",
        "Instructions": ""
      },
      {
        "Description": "Military Discount",
        "Instructions": ""
      }
    ],
    "FacilityFeatures": [
      {
        "Description": "",
        "ImageUrl": "http:///Image/4c514546-bae3-4651-82df-e734c3291edd"
      },
      {
        "Description": "",
        "ImageUrl": "http:///Image/da5fd3ea-d76e-47f9-8a48-db9711f07a3e"
      }
    ],
    "HoursOfOperation": {
      "Gate": {
        "Friday": {
          "Close": "",
          "IsOpen": false,
          "Open": ""
        },
        "Monday": {
          "Close": "",
          "IsOpen": false,
          "Open": ""
        },
        "Saturday": {
          "Close": "",
          "IsOpen": false,
          "Open": ""
        },
        "Sunday": {
          "Close": "",
          "IsOpen": false,
          "Open": ""
        },
        "Thursday": {
          "Close": "",
          "IsOpen": false,
          "Open": ""
        },
        "Tuesday": {
          "Close": "",
          "IsOpen": false,
          "Open": ""
        },
        "Wednesday": {
          "Close": "",
          "IsOpen": false,
          "Open": ""
        }
      },
      "Office": {
        "Friday": {
          "Close": "18:00:00",
          "IsOpen": true,
          "Open": "04:00:00"
        },
        "Monday": {
          "Close": "18:00:00",
          "IsOpen": true,
          "Open": "04:00:00"
        },
        "Saturday": {
          "Close": "16:00:00",
          "IsOpen": true,
          "Open": "08:00:00"
        },
        "Sunday": {
          "Close": "14:00:00",
          "IsOpen": true,
          "Open": "06:00:00"
        },
        "Thursday": {
          "Close": "18:00:00",
          "IsOpen": true,
          "Open": "04:00:00"
        },
        "Tuesday": {
          "Close": "18:00:00",
          "IsOpen": true,
          "Open": "04:00:00"
        },
        "Wednesday": {
          "Close": "18:00:00",
          "IsOpen": true,
          "Open": "04:00:00"
        }
      }
    },
    "LocationFeatures": [      
      {
        "Description": "drive up"
      },
      {
        "Description": "24-hour access"
      }
    ],
    "LocationServices": [
      {
        "Amount": 1,
        "Description": "$1 MOVE IN",
        "LocationServiceNumber": "2cd90019-9d6a-4a04-b480-c83cfcb54e7e",
        "Taxable": "False"
      }
    ],
    "Name": "WSS TEST AFFILIATE 3",
    "Phone": "6660000666",
    "ReservationDates": [
      "5/8/2019",
      "5/9/2019",
      "5/10/2019",
      "5/11/2019",
      "5/12/2019",
      "5/13/2019",
      "5/14/2019"
    ],
    "ReservationNotBelowPercentage": "0",
    "ReservationNotBelowTotalUnits": "0",
    "ReviewFee": 6.95,
    "Units": [
      {
        "SizeDescriptionsField": [
          "Interior 10th Mezzanine Level Climate Stair Rollup Electricity"
        ],
        "BonusComments": "Probably don't use for big and/or heavy furniture, being a stair access 10th floor units",
        "CubicFootage": 1638,
        "OrderGrouping": "000001Interior",
        "SquareFootage": 156,
        "TotalUnits": 17,
        "UnitFeature": null,
        "UnitStorageGuide": null,
        "UnitTypeImage": null,
        "Height": 10.5,
        "InsuranceOptions": [
          {
            "Description": "INSURANCE $10,000",
            "Due": 0,
            "InsuranceId": "63e2c027-bd3e-4124-9156-1d44e44474a3",
            "MonthlyRate": 20.95,
            "Percentage": 0,
            "Quantity": 0,
            "Selected": false,
            "Tax": 0,
            "Total": 0
          },
          {
            "Description": "INSURANCE $15,000",
            "Due": 0,
            "InsuranceId": "aa57a266-f7cd-4052-875a-988a64e48523",
            "MonthlyRate": 35.95,
            "Percentage": 0,
            "Quantity": 0,
            "Selected": false,
            "Tax": 0,
            "Total": 0
          },
          {
            "Description": "INSURANCE $1,000",
            "Due": 0,
            "InsuranceId": "234f2ca6-f2ed-4b1e-a63d-b96ad8636a39",
            "MonthlyRate": 7.95,
            "Percentage": 0,
            "Quantity": 0,
            "Selected": false,
            "Tax": 0,
            "Total": 0
          },
          {
            "Description": "INSURANCE $5,000",
            "Due": 0,
            "InsuranceId": "2a945398-41df-4b19-b7fb-bc5ab8652cbe",
            "MonthlyRate": 10.95,
            "Percentage": 0,
            "Quantity": 0,
            "Selected": false,
            "Tax": 0,
            "Total": 0
          }
        ],
        "IsCampusStorage": false,
        "Length": 12,
        "Monthly": 49.95,
        "Portable": {
          "IsPortable": false,
          "OnSiteOnly": true,
          "WaiveDeliveryFee": false
        },
        "ServiceCharges": null,
        "UnitId": "f6a33134-e66c-46d0-8100-49779210fe91",
        "RentableObjectId": "86568e4a-dec5-455b-bb9f-02f6a49cbbbf",
        "UnitSize": "13x12x10.5",
        "VacantUnits": 5,
        "Width": 13
      }
    ]
  },
  "Success": true,
  "ErrorMessage": ""
}

Location Reviews

/wssapi/v2/location/{entity}/reviews

Lists reviews for the location

Action
GET
{entity}
String value of the location entity for which to return information
{
    "Reviews": [
        {
            "Date": "2011-05-13T13:19:16.23",
            "CustomerName": "CODE U",
            "Rating": 6,
            "Review": "REVIEW TESTING",
            "Reply": ""
        },
        {
            "Date": "2010-10-15T15:00:38.85",
            "CustomerName": "METEOR S",
            "Rating": 10,
            "Review": "Love it!",
            "Reply": "Thanks!"
        }
        //...
    ],
    "Success": true,
    "ErrorMessage": ""
}

Location Images

/wssapi/v2/location/{entity}/images

Lists images for the location

Action
GET
{entity}
String value of the location entity for which to return information
{
    "ImageLinks": [
    "http:///Image/4c514546-bae3-4651-82df-e734c3291edd/UsingWidth/480",
    "http:///Image/da5fd3ea-d76e-47f9-8a48-db9711f07a3e/UsingWidth/480"
  ],
    "Success": true,
    "ErrorMessage": ""
}

Reservation

/wssapi/v2/reservation/{entity}

Makes a reservation at the location

Action
POST
{entity}
String value of the location entity for which to return information
{
    "ReservationDay": "05/15/2015",
    "Units": [{
        "UnitID": "f47b9ab6-22df-4a65-b65f-0fad6bf47fcc",
        "InsuranceID": "2a945398-41df-4b19-b7fb-bc5ab8652cbe"
    }],
    "PaymentInfo": {
        "FirstName": "User",
        "LastName": "Userson",
        "Address1": "2727 N Central Ave",
        "Address2": "",
        "City": "Phoenix",
        "State": "AZ",
        "Zip": "85022",
        "Phone": "6022877878",
        "Email": "email@example.com",
        "CreditCard": "6011000000000000",
        "ExpirationMMYY": "1215",
        "CSC": "100"
    }
}
    
 {
    "Entity": 990019,
    "MoveInDate": "2019-05-08T18:05:58.435Z",
    "TotalCost": 0,
    "ReservationNumber": "990019-00008629",
    "Success": true,
    "ErrorMessage": ""
}

Errors

404

Invalid endpoint

{
    "Success": false,
    "ErrorMessage": "Endpoint not found: v2/path"
}

Invalid API Key

Your API key was not specified in the Authorization header

{
    "Success": false,
    "ErrorMessage": "Unauthorized. Specify your API key in the Authorization header."
}

Invalid Entity

Invalid entity specified, either it does not exist or you do not have access

{
    "Parameter": "entity",
    "Reason": "Your key does not have permissions to that entity",
    "Success": false,
    "ErrorMessage": "An invalid parameter was specified"
}

Invalid Reservation

The reservation could not be made.

ErrorKind

  • InvalidLocation - There was an error with the specified entity
  • InvalidDate - That location is not accepting reservations for the specified date - Use a supplied date in the ReservationDates field
  • InvalidCart - An internal service error occured
  • InvalidUnit - The location is not accepting reservations for the specified unit
  • InvalidInsurance - The specified insurance is not valid for the unit
  • InvalidContact - The supplied contact credentials are invalid
  • InvalidPayment - The credit card details were invalid
{
    "ErrorKind": "InvalidContact",
    "Success": false,
    "ErrorMessage": "An internal service error occured."
}