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.


export class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public ApiKey: string;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    public Description: string;
    public Heading: string;
    public WasSuccessful: boolean;
    public ModelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export enum IntegrationProviderType
{
    None = 0,
    EA = 1,
    IlluminaHubProtectMe = 2,
    MyLegalHand = 3,
    AccidentAngels = 4,
    EmergencyServices = 5,
    MightyMobile = 6,
    Pulsit = 7,
    Bolt = 8,
}

export class UserProductAttachmentData
{
    public FileName: string;
    public MainFileUrl: string;
    public ThumbnailUrl: string;
    public IsVideo: boolean;
    public IsImage: boolean;
    public IsPdf: boolean;

    public constructor(init?: Partial<UserProductAttachmentData>) { (Object as any).assign(this, init); }
}

export class UserProductData
{
    public IntegrationType: IntegrationProviderType;
    public ProductId: number;
    public Name: string;
    public NameAfrikaans: string;
    public DashImageUrl: string;
    public ActionUrl: string;
    public Attachments: UserProductAttachmentData[];
    public DescriptionEng: string;
    public SummaryEng: string;
    public DescriptionAfr: string;
    public SummaryAfr: string;

    public constructor(init?: Partial<UserProductData>) { (Object as any).assign(this, init); }
}

export class DependentData
{
    /** @description Dependent's Galaxy Id used for referring to or deleting. */
    // @ApiMember(Description="Dependent's Galaxy Id used for referring to or deleting.", IsRequired=true)
    public DependentId: number;

    /** @description Dependent's first name. */
    // @ApiMember(Description="Dependent's first name.", IsRequired=true)
    public FirstName: string;

    /** @description Dependent's surname. */
    // @ApiMember(Description="Dependent's surname.", IsRequired=true)
    public Surname: string;

    /** @description Dependent's mobile contact number. */
    // @ApiMember(Description="Dependent's mobile contact number.", IsRequired=true)
    public MobileNumber: string;

    /** @description Dependent's email address. */
    // @ApiMember(Description="Dependent's email address.", IsRequired=true)
    public Email: string;

    /** @description Depdendent's ID number. */
    // @ApiMember(Description="Depdendent's ID number.", IsRequired=true)
    public IdNumber: string;

    public constructor(init?: Partial<DependentData>) { (Object as any).assign(this, init); }
}

export class UserLoginResponse extends ApiServiceResponse
{
    /** @description List of products the user has access to. */
    // @ApiMember(Description="List of products the user has access to.")
    public UserProductInformation: UserProductData[];

    /** @description List of all dependents linked to this user. */
    // @ApiMember(Description="List of all dependents linked to this user.")
    public Dependents: DependentData[];

    public constructor(init?: Partial<UserLoginResponse>) { super(init); (Object as any).assign(this, init); }
}

export class UserLoginRequest extends ApiServiceRequest
{
    /** @description ID Number of the user to log in. */
    // @ApiMember(Description="ID Number of the user to log in.", IsRequired=true)
    public IdNumber: string;

    public constructor(init?: Partial<UserLoginRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript UserLoginRequest DTOs

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 /user/login HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	IdNumber: String,
	ApiKey: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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: {}
}