GalaxyMobile Client API

<back to all web services

UserLoginRequest

The following routes are available for this service:
POST/user/loginCheck that the user exists on Galaxy and set up their account and services.
UserLoginRequest Parameters:
NameParameterData TypeRequiredDescription
IdNumberbodystringYesID Number of the user to log in.
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
UserLoginResponse Parameters:
NameParameterData TypeRequiredDescription
UserProductInformationformList<UserProductData>NoList of products the user has access to.
DependentsformList<DependentData>NoList of all dependents linked to this user.
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
UserProductData Parameters:
NameParameterData TypeRequiredDescription
IntegrationTypeformIntegrationProviderTypeNo
ProductIdformintNo
NameformstringNo
NameAfrikaansformstringNo
DashImageUrlformstringNo
ActionUrlformstringNo
AttachmentsformList<UserProductAttachmentData>No
DescriptionEngformstringNo
SummaryEngformstringNo
DescriptionAfrformstringNo
SummaryAfrformstringNo
IntegrationProviderType Enum:
NameValue
None0
EA1
IlluminaHubProtectMe2
MyLegalHand3
AccidentAngels4
EmergencyServices5
MightyMobile6
Pulsit7
Bolt8
UserProductAttachmentData Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
MainFileUrlformstringNo
ThumbnailUrlformstringNo
IsVideoformboolNo
IsImageformboolNo
IsPdfformboolNo
DependentData Parameters:
NameParameterData TypeRequiredDescription
DependentIdformintYesDependent's Galaxy Id used for referring to or deleting.
FirstNameformstringYesDependent's first name.
SurnameformstringYesDependent's surname.
MobileNumberformstringYesDependent's mobile contact number.
EmailformstringYesDependent's email address.
IdNumberformstringYesDepdendent's ID number.

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /user/login HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"IdNumber":"String","ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"UserProductInformation":[{"IntegrationType":0,"ProductId":0,"Name":"String","NameAfrikaans":"String","DashImageUrl":"String","ActionUrl":"String","Attachments":[{"FileName":"String","MainFileUrl":"String","ThumbnailUrl":"String","IsVideo":false,"IsImage":false,"IsPdf":false}],"DescriptionEng":"String","SummaryEng":"String","DescriptionAfr":"String","SummaryAfr":"String"}],"Dependents":[{"DependentId":0,"FirstName":"String","Surname":"String","MobileNumber":"String","Email":"String","IdNumber":"String"}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}