Potential Franchisee API

Authentication

Provide an Authorization header with the following format

Basic base64Encode(user_name:company_id:api_key)

A Zr Ware™ system administrator will provide you the user_name, company_id, and api_key for your integration.

Example Authentication Errors

Status Code - 500

You will currently receive a text/html raw apache error log where it will inform you have an Invalid Authorization Token. Ignore the prompt where it says "Format should be" and double check that the Authorization header is formatted as described above and that Zr Ware™ engineers have fully enabled the integration.

Note: We are still in the process of standardizing error responses that come back due to authentication errors.

Api Call

POST /api/v1/potentialFranchisee

A Zr Ware™ system administrator will provide the host/domain to which you will send data.

Example Payload - JSON

{
  "organizationId": 1,
  "fullName": "John Doe",
  "email": "[e-mail]",
  "phone": "8881112222",
  "zipCode": "84045",
  "territoryOfInterest": "I would like A B and C",
  "aboutYourself": "Lorem ipsum dolem"
}

Payload Description

Field	Type	Required	Description
organizationId	Number	Yes	The internal id of the Zr Ware™ organization with which this information should be associated. This value is currently 1 for all requests
fullName	String - max-length 1000	Yes
email	String - max-length 255	Yes
phone	String - max-length 16	Yes
zipCode	String - max-length 12	Yes
territoryOfInterest	String - max-length 100	Yes
aboutYourself	String - max-length 5000	Yes

Example Responses - JSON

Information was successfully processed and an e-mail notification sent to the customer

StatusCode - 200

{
  "message": "The data was successfully processed."
}

 

Information was successfully processed but an e-mail notification was NOT sent to the email in the payload.

StatusCode - 200

{
  "message": "The data was successfully saved but we failed to send [email] an e-mail."
}

 

Invalid Organization Id 

Status Code - 400

{
  "message": "Invalid organization."
}

Missing Required Field

Status Code - 400

{
  "message": "Missing [required field]."
}

Cannot deserialize payload

Status Code - 400

{
  "message": "An invalid request was sent",
}

Internal Server Error

Status Code - 500

{
  "message": "Internal error."
}

Note: Work is still being performed to standardize successful and unsuccessful error responses.