ServiceRequest

The ServiceRequest endpoint can be used to add a service appointment to EPASS.
Tags:
Categories:

Service Request Web Page Sample Files

Need a quick solution for your custom Service Request web page? Download and customize our sample files.

Add a Service Request

POST /external/servicerequest

This endpoint adds a new service request to EPASS.

  • For more information on EPASS service requests and how to set up your EPASS system to accept them, refer to the EPASS Help.

Payload

Required Fields

The following fields are the absolute minimum fields that are required to add a service request.

Name Type Description
firstName string The customer’s first name.
lastName string The customer’s last name.
address1 string The customer’s street address.
city string The customer’s city.
state string The customer’s state or province.
zip string The customer’s zip or postal code.
phone1 string The customer’s phone number.
email string The customer’s email.
brand string The brand code of the model that requires service. This must be a valid code found in the Brand table of EPASS.
dealercode string The dealer where the model was purchased from. This must be a valid code found in the Dealer table of EPASS.
product string The model’s product category code.
model string The model code.
serial string The model’s serial number.
complaint string The customer’s description of the complaint or reason for service.
datePurchased string Format: YYY-MM-DDThh:mm:ss.ssZ
The original purchase date of the model.

Optional Fields

These fields are optional and do not need to be included in the payload.

Name Type Description
address2 string Optional secondary address line.
country string The customer’s country.
phone2 string Optional secondary phone number

Sample: Adding a Service Request


POST /external/servicerequest
{
    "lastName": "Smith",
    "firstName": "John",
    "address1": "1111 Main street",
    "address2": null,
    "city": "Anytown",
    "state": "BC",
    "zip": "V4W 0Y2",
    "country": null,
    "phone1": "60411111111",
    "phone2": null,
    "email": "myemail@gmail.com",
    "brand": "aga",
    "dealerCode": "DEW",
    "product": "11112",
    "model": "modelAR",
    "serial": "SerialNum",
    "complaint": "Ice maker won't make ice",
    "datePurchased": "2022-02-15T09:00:00"
}

 {
    "success": true,
    "warning": false,
    "httpStatusCode": 201,
    "generalMessage": null,
    "exceptionMessage": null,
    "keys": [
        {
            "table": "ServiceRequest",
            "keys": [
                {
                    "key": "ID",
                    "fields": [
                        {
                            "fieldName": "ID",
                            "fieldValue": 5
                        }
                    ]
                }
            ]
        }
    ],
    "messages": [],
    "warnings": []
}

  {
    "success": false,
    "warning": false,
    "httpStatusCode": 422,
    "generalMessage": "One or more of the fields has an invalid or missing value.",
    "exceptionMessage": null,
    "keys": [],
    "messages": [
        {
            "code": "ServReq-00031",
            "message": "Dealer Info is missing."
        }
    ],
    "warnings": []
}