Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
133 lines (133 sloc) 4.2 KB
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://github.com/route4me/route4me-json-schemas/blob/master/User_v4.dtd",
"title": "User (v4)",
"type": "object",
"description": "For new account registration. url: https://route4me.com/api.v4/user.php",
"required": [
"api_key",
"member_type",
"member_email",
"OWNER_MEMBER_ID",
"member_password"
],
"properties": {
"api_key": {
"type": "string",
"title": "API key",
"description": "API key of an user. HTTP method - GET"
},
"device_id": {
"type": "string",
"title": "Device ID",
"description": "HTTP method - GET. If a device ID is passed, the registration page assumes a temporary member associated with that device id exists. The registration page updates that member's information, sets an email address. After completion, the member is no longer temporary and the member_id is preserved."
},
"member_first_name": {
"type": "string",
"title": "Member First Name",
"description": "The first name of the user. HTTP method - POST."
},
"member_last_name": {
"type": "string",
"title": "Member Last Name",
"description": "The last name of the user. HTTP method - POST."
},
"member_phone": {
"type": "string",
"title": "Member Phone",
"description": "A phone number of the user. HTTP method - POST."
},
"member_type": {
"type": "string",
"title": "Member Type",
"description": "Member type, ENUM [SUB_ACCOUNT_ADMIN, SUB_ACCOUNT_REGIONAL_MANAGER, SUB_ACCOUNT_DISPATCHER, SUB_ACCOUNT_DRIVER]. HTTP method - POST."
},
"member_email": {
"type": "string",
"title": "Member Email",
"format": "email",
"description": "E-mail address of the user that was used for site registration. HTTP method - POST."
},
"member_password": {
"type": "string",
"title": "Member Password",
"description": "Member Password. HTTP method - POST."
},
"OWNER_MEMBER_ID": {
"type": "string",
"title": "Owner Member ID",
"description": "Parent user ID. HTTP method - POST."
},
"member_zipcode": {
"type": "string",
"title": "Zip code",
"pattern": "^[0-9]{5,7}$",
"description": "The 5-7 digit ZIP code (minimum length of 5)). HTTP method - POST."
},
"preferred_language": {
"type": "string",
"title": "Preferred Language",
"description": "Preferred language, ENUM [en, fr, ...]. HTTP method - POST."
},
"preferred_units": {
"type": "string",
"title": "Preferred Units",
"description": "Preferred units, ENUM [km, ml]. HTTP method - POST."
},
"timezone": {
"type": "string",
"title": "Timezone",
"description": "Member timezone. HTTP method - POST."
},
"user_reg_country_id": {
"type": "integer",
"title": "User Region Country ID",
"description": "Member country, Enum(COUNTRY_CODES). HTTP method - POST."
},
"user_reg_state_id": {
"type": "integer",
"title": "User Region State ID",
"description": "Member state, Enum(COUNTRY_CODES). HTTP method - POST."
},
"HIDE_NONFUTURE_ROUTES": {
"type": "string",
"title": "Hide Nonfuture Routes",
"description": "Hide non-future routes, ENUM['TRUE', 'FALSE']. HTTP method - POST."
},
"HIDE_VISITED_ADDRESSES": {
"type": "string",
"title": "Hide Visited Addresses",
"description": "Hide visited sddresses, ENUM['TRUE, 'FALSE']. HTTP method - POST."
},
"HIDE_ROUTED_ADDRESSES": {
"type": "string",
"title": "Hide Routed Addresses",
"description": "Hide routed sddresses, ENUM['TRUE', 'FALSE']. HTTP method - POST."
},
"READONLY_USER": {
"type": "string",
"title": "Readonly User",
"description": "Readonly user, ENUM['TRUE', 'FALSE']. HTTP method - POST."
},
"SHOW_ALL_DRIVERS": {
"type": "string",
"title": "Show All Drivers",
"description": "Show all drivers, ENUM['TRUE', 'FALSE']. HTTP method - POST."
},
"SHOW_ALL_VEHICLES": {
"type": "string",
"title": "Show All Vehicles",
"description": "Show all vehicles, ENUM['TRUE', 'FALSE']. HTTP method - POST."
},
"date_of_birth": {
"type": "string",
"title": "Date of Birth",
"description": "Date of birth. HTTP method - POST."
},
"custom_data": {
"type": "string",
"title": "Custom data",
"description": "User's custom data (JSON string) - POST."
}
}
}