Requesting Support

Requesting Cargo Spectre support is a one step POST request that initiates the support process on the machine. Once the process completes a Cargo Spectre representative can remote into the machine and assist the user. Please note it is important to fill out the appropriate contact fields in the original request in case further contact is needed.

Request

Request a dimension from a machine with local IP address 10.1.1.2 set to port 7100. A request should be filled out with the user's name, email, phoneNumber, problem, location, description

POST

Endpoint

POSThttp://10.1.1.2:7100/

Header

XML

Desired response format:

Accept: application/xml (default)

JSON

Desired response format:

Accept: application/json

Body

XML

caution

All fields must be filled out or an error will be received when sending the request.

• Special Note: Problem and Location properties are for internal use only and must be set to "unknown".

• Name - Name of the user sending the support request.
• Email - User email address.
• Phone - User phone number, format is not requirement (hyphens, or parentheses), but area codes are important, especially if users are outside of the US.
• Location - Set as unknown.
• Description - Set as unknown.

<Requests>
  <RequestSupport>
    <Name>John Smith</Name>
    <Email>john@fakeshipper.com</Email>
    <Phone>555-555-5555</Phone>
    <Problem>unknown</Problem>
    <Location>unknown</Location>
    <Description>Having trouble signing in</Description>
  </RequestSupport>
</Requests>

JSON

caution

All fields must be filled out or an error will be received when sending the request.

• Special Note: Problem and Location properties must be set to "unknown".

• Name - Name of the user sending the support request.
• Email - User email address.
• Phone - User phone number, format is not requirement (hyphens, or parentheses), but area codes are important, especially if users are outside of the US.
• Location - Set as unknown.
• Description - Set as unknown.

{
    "Requests": {
        "RequestSupport": {
            "Name": "John Smith",
            "Email": "john@fakeshipper.com",
            "Phone": "555-555-5555",
            "Problem": "unknown",
            "Location": "unknown",
            "Description": "Having trouble signing in"
        }
    }
}

Response

A code of 0 will remain the support request was successful and that the support script is up and running.

XML

<Responses>
    <RequestSupport code="0"/>
</Responses>

JSON

info

value will be returned as an empty string for this API and should be disregarded

{
    "Responses": {
        "RequestSupport": {
            "code": "0",
            "value": ""
        }
    }
}