{
    "clientRef": "29",
    "contactRef": "ZARADILLO1",
    "salutation": "Mr",
    "forename": "John",
    "surname": "Test",
    "contact1": "",
    "contact1Type": "1",
    "contact2": "07123456789",
    "contact2Type": "10",
    "contact3": "test@test.test",
    "contact3Type": "6",
    "contact4": "",
    "contact4Type": "1",
    "preferredContact": "1",
    "address1": "Address line 1",
    "address2": "Address line 2",
    "address3": "Address line 3",
    "address4": "Address line 4",
    "notes": "These are notes",
    "considerations": "These are considerations",
    "postCode": "EX49HL",
    "locations": [
        {
            "locationRef": "10174",
            "isPreferred": "True",
            "startDate": "09/07/2019",
            "endDate": "18/12/2019",
            "usageTypeId": "1"
        }
    ]
}

Response

401 Unauthorized

Reason

This error occurs if the OS_REST_AUTH_TOKEN has not been provided, has expired, or does not exist in the system

Resolution

Verify your OS_REST_AUTH_TOKEN with support

Response

403 Forbidden

Reason

This error indicates that something is blocking your connection to the server

Resolution

Open a ticket with the support team with details of your connection so that your access can be verfied

Response

404 Not Found

Reason

This error should only occur if the endpoint has been mistyped in some way, which will lead the call to an endpoint that does not exist

Resolution

Verify the endpoint matches the value specified in this article

Response

405 Method Not Allowed

Reason

This error will occur if an unacceptable method has been used in the call such as GET or DELETE

Resolution

Ensure that you are using a POST call to this endpoint

Response

415 Unsupported Media Type

Reason

This response is given if data is passed to the endpoint in a format other than application/json

Resolution

Pass your requests as a JSON object with the application/json header

Response

{
    "result": "fail",
    "result_msg": "REST0002",
    "result_error_msg": "A JSONObject text must begin with '{' at character..."
}

Reason

This error occurs if you have tried to pass a call that isn't wrapped as a JSON object. For example:

[
    {
        "clientRef": "29",
        ...
    }
]

Resolution

Ensure that all calls are valid JSON objects following a similar layout to the example call above

Response

{
    "result": "fail",
    "result_msg": "Transaction rolled back because it has been marked as rollback-only"
}

Reason

This is a generic server error which usually indicates that a field is of the wrong type or is overlong, which causes a failure to insert the data into the database

Resolution

Ensure that all fields are filled out according to the field data types listed above

Response

{
    "result": "fail",
    "result_msg": "could not execute statement; SQL [n/a]; nested exception is org.hibernate.exception.DataException: could not execute statement"
}

Reason

This is a generic server error which usually indicates that a field is of the wrong type or is overlong, which causes a failure to insert the data into the database

Resolution

Ensure that all fields are filled out according to the field data types listed above

Response

{
    "result": "fail",
    "result_msg": "Unable to locate client ref supplied"
}

Reason

This error is returned when a client with the provided ID cannot be found in the system

Resolution

Ensure that the client exists in Oneserve and that all fields are filled out according to the field data types listed above