Customers
Customers are entered by appraisers and have one or more Gitfax items.

Supported Formats

json
>>>

GET /customers
List customers

Returns customers matching the criteria you provide.

Supported Formats

json

Errors

Code Description
400 The request was unacceptable, often due to missing a required parameter.

Params

Param name Description
page
optional

Validations:

  • Must be Integer.
per_page
optional

Validations:

  • Must be Integer.
>>>

GET /customers/:id
Show a customer

Supported Formats

json

Errors

Code Description
400 The request was unacceptable, often due to missing a required parameter.
>>>

POST /items
Create a customer

Create the customer by passing required fields.

Supported Formats

json

Errors

Code Description
400

Params

Param name Description
first_name
required

Validations:

  • Must be a String
last_name
required

Validations:

  • Must be a String
email
required

Validations:

  • Must be a String
phone
optional

Validations:

  • Must be a String
address
optional

Validations:

  • Must be a String
city
optional

Validations:

  • Must be a String
state
optional

Validations:

  • Must be a String
zip
optional

Validations:

  • Must be a String
>>>

PUT /customers/:id
Update a customer

Modify the customer by passing new parameter values. Changes you make are permanently logged to the item’s history and update its modification date. An item’s serial number and/or RFID value cannot be changed after it is created.

Supported Formats

json

Errors

Code Description
400

Params

Param name Description
first_name
required

Validations:

  • Must be a String
last_name
required

Validations:

  • Must be a String
email
required

Validations:

  • Must be a String
phone
optional

Validations:

  • Must be a String
address
optional

Validations:

  • Must be a String
city
optional

Validations:

  • Must be a String
state
optional

Validations:

  • Must be a String
zip
optional

Validations:

  • Must be a String
>>>

DELETE /customers/:id
Destroy a customer

Note: You must be a GitFax administrator to use this API. Because GitFax stores permanent records of instrument manufacture and maintenance, deleting records is not common.

Supported Formats

json

Errors

Code Description
400 The request was unacceptable, often due to missing a required parameter.