GalaxyMobile Client API

UserLoginRequest

The following routes are available for this service:
POST	/user/login	Check that the user exists on Galaxy and set up their account and services.

**UserLoginRequest** Parameters:
Name	Parameter	Data Type	Required	Description
IdNumber	body	string	Yes	ID Number of the user to log in.

**ApiServiceRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	form	string	Yes	The API Key required for authentication

**UserLoginResponse** Parameters:
Name	Parameter	Data Type	Required	Description
UserProductInformation	form	List<UserProductData>	No	List of products the user has access to.
Dependents	form	List<DependentData>	No	List of all dependents linked to this user.

**ApiServiceResponse** Parameters:
Name	Parameter	Data Type	Required
Description	form	string	No
Heading	form	string	No
WasSuccessful	form	bool	No
ModelState	form	Object	No

**UserProductData** Parameters:
Name	Parameter	Data Type	Required
IntegrationType	form	IntegrationProviderType	No
ProductId	form	int	No
Name	form	string	No
NameAfrikaans	form	string	No
DashImageUrl	form	string	No
ActionUrl	form	string	No
Attachments	form	List<UserProductAttachmentData>	No
DescriptionEng	form	string	No
SummaryEng	form	string	No
DescriptionAfr	form	string	No
SummaryAfr	form	string	No

**IntegrationProviderType** Enum:
Name	Value
None	0
EA	1
IlluminaHubProtectMe	2
MyLegalHand	3
AccidentAngels	4
EmergencyServices	5
MightyMobile	6
Pulsit	7
Bolt	8

**UserProductAttachmentData** Parameters:
Name	Parameter	Data Type	Required
FileName	form	string	No
MainFileUrl	form	string	No
ThumbnailUrl	form	string	No
IsVideo	form	bool	No
IsImage	form	bool	No
IsPdf	form	bool	No

**DependentData** Parameters:
Name	Parameter	Data Type	Required	Description
DependentId	form	int	Yes	Dependent's Galaxy Id used for referring to or deleting.
FirstName	form	string	Yes	Dependent's first name.
Surname	form	string	Yes	Dependent's surname.
MobileNumber	form	string	Yes	Dependent's mobile contact number.
Email	form	string	Yes	Dependent's email address.
IdNumber	form	string	Yes	Depdendent's ID number.

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<UserLoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.User">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
  <IdNumber>String</IdNumber>
</UserLoginRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserLoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.User">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <Dependents>
    <DependentData>
      <DependentId>0</DependentId>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <IdNumber>String</IdNumber>
      <MobileNumber>String</MobileNumber>
      <Surname>String</Surname>
    </DependentData>
  </Dependents>
  <UserProductInformation>
    <UserProductData>
      <ActionUrl>String</ActionUrl>
      <Attachments>
        <UserProductAttachmentData>
          <FileName>String</FileName>
          <IsImage>false</IsImage>
          <IsPdf>false</IsPdf>
          <IsVideo>false</IsVideo>
          <MainFileUrl>String</MainFileUrl>
          <ThumbnailUrl>String</ThumbnailUrl>
        </UserProductAttachmentData>
      </Attachments>
      <DashImageUrl>String</DashImageUrl>
      <DescriptionAfr>String</DescriptionAfr>
      <DescriptionEng>String</DescriptionEng>
      <IntegrationType>None</IntegrationType>
      <Name>String</Name>
      <NameAfrikaans>String</NameAfrikaans>
      <ProductId>0</ProductId>
      <SummaryAfr>String</SummaryAfr>
      <SummaryEng>String</SummaryEng>
    </UserProductData>
  </UserProductInformation>
</UserLoginResponse>