heilog.ch.Api

<back to all web services

AuthRequest

The following routes are available for this service:
POST/auth
AuthRequest Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringNo
PasswordbodystringNo
WebsitebodyWebsiteNo
Website Enum:
NameValue
Platform1
Admin2
AuthResponse Parameters:
NameParameterData TypeRequiredDescription
UserIdformlongNo
EmailformstringNo
LanguageCodeformLanguageCodeNo
BearerTokenformstringNo
ResponseStatusformResponseStatusNo
LanguageCode Enum:
NameValue
de1
fr2
it3

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /auth HTTP/1.1 
Host: heidak-api.build.exanic.ch 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	email: String,
	password: String,
	website: 1
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	userId: 0,
	email: String,
	languageCode: 1,
	bearerToken: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}