| POST | /user/login | Check that the user exists on Galaxy and set up their account and services. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class UserLoginRequest extends ApiServiceRequest
{
/**
* ID Number of the user to log in.
*/
@ApiMember(Description="ID Number of the user to log in.", IsRequired=true)
public String IdNumber = null;
public String getIdNumber() { return IdNumber; }
public UserLoginRequest setIdNumber(String value) { this.IdNumber = value; return this; }
}
public static class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public String ApiKey = null;
public String getApiKey() { return ApiKey; }
public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
}
public static class UserLoginResponse extends ApiServiceResponse
{
/**
* List of products the user has access to.
*/
@ApiMember(Description="List of products the user has access to.")
public ArrayList<UserProductData> UserProductInformation = null;
/**
* List of all dependents linked to this user.
*/
@ApiMember(Description="List of all dependents linked to this user.")
public ArrayList<DependentData> Dependents = null;
public ArrayList<UserProductData> getUserProductInformation() { return UserProductInformation; }
public UserLoginResponse setUserProductInformation(ArrayList<UserProductData> value) { this.UserProductInformation = value; return this; }
public ArrayList<DependentData> getDependents() { return Dependents; }
public UserLoginResponse setDependents(ArrayList<DependentData> value) { this.Dependents = value; return this; }
}
public static class ApiServiceResponse implements IServiceResponse
{
public String Description = null;
public String Heading = null;
public Boolean WasSuccessful = null;
public Object ModelState = null;
public String getDescription() { return Description; }
public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
public String getHeading() { return Heading; }
public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
public Boolean isWasSuccessful() { return WasSuccessful; }
public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
public Object getModelState() { return ModelState; }
public ApiServiceResponse setModelState(Object value) { this.ModelState = value; return this; }
}
public static class UserProductData
{
public IntegrationProviderType IntegrationType = null;
public Integer ProductId = null;
public String Name = null;
public String NameAfrikaans = null;
public String DashImageUrl = null;
public String ActionUrl = null;
public ArrayList<UserProductAttachmentData> Attachments = null;
public String DescriptionEng = null;
public String SummaryEng = null;
public String DescriptionAfr = null;
public String SummaryAfr = null;
public IntegrationProviderType getIntegrationType() { return IntegrationType; }
public UserProductData setIntegrationType(IntegrationProviderType value) { this.IntegrationType = value; return this; }
public Integer getProductId() { return ProductId; }
public UserProductData setProductId(Integer value) { this.ProductId = value; return this; }
public String getName() { return Name; }
public UserProductData setName(String value) { this.Name = value; return this; }
public String getNameAfrikaans() { return NameAfrikaans; }
public UserProductData setNameAfrikaans(String value) { this.NameAfrikaans = value; return this; }
public String getDashImageUrl() { return DashImageUrl; }
public UserProductData setDashImageUrl(String value) { this.DashImageUrl = value; return this; }
public String getActionUrl() { return ActionUrl; }
public UserProductData setActionUrl(String value) { this.ActionUrl = value; return this; }
public ArrayList<UserProductAttachmentData> getAttachments() { return Attachments; }
public UserProductData setAttachments(ArrayList<UserProductAttachmentData> value) { this.Attachments = value; return this; }
public String getDescriptionEng() { return DescriptionEng; }
public UserProductData setDescriptionEng(String value) { this.DescriptionEng = value; return this; }
public String getSummaryEng() { return SummaryEng; }
public UserProductData setSummaryEng(String value) { this.SummaryEng = value; return this; }
public String getDescriptionAfr() { return DescriptionAfr; }
public UserProductData setDescriptionAfr(String value) { this.DescriptionAfr = value; return this; }
public String getSummaryAfr() { return SummaryAfr; }
public UserProductData setSummaryAfr(String value) { this.SummaryAfr = value; return this; }
}
public static enum IntegrationProviderType
{
@SerializedName("0") None(0),
@SerializedName("1") Ea(1),
@SerializedName("2") IlluminaHubProtectMe(2),
@SerializedName("3") MyLegalHand(3),
@SerializedName("4") AccidentAngels(4),
@SerializedName("5") EmergencyServices(5),
@SerializedName("6") MightyMobile(6),
@SerializedName("7") Pulsit(7),
@SerializedName("8") Bolt(8);
private final int value;
IntegrationProviderType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static class UserProductAttachmentData
{
public String FileName = null;
public String MainFileUrl = null;
public String ThumbnailUrl = null;
public Boolean IsVideo = null;
public Boolean IsImage = null;
public Boolean IsPdf = null;
public String getFileName() { return FileName; }
public UserProductAttachmentData setFileName(String value) { this.FileName = value; return this; }
public String getMainFileUrl() { return MainFileUrl; }
public UserProductAttachmentData setMainFileUrl(String value) { this.MainFileUrl = value; return this; }
public String getThumbnailUrl() { return ThumbnailUrl; }
public UserProductAttachmentData setThumbnailUrl(String value) { this.ThumbnailUrl = value; return this; }
public Boolean getIsVideo() { return IsVideo; }
public UserProductAttachmentData setIsVideo(Boolean value) { this.IsVideo = value; return this; }
public Boolean getIsImage() { return IsImage; }
public UserProductAttachmentData setIsImage(Boolean value) { this.IsImage = value; return this; }
public Boolean getIsPdf() { return IsPdf; }
public UserProductAttachmentData setIsPdf(Boolean value) { this.IsPdf = value; return this; }
}
public static class DependentData
{
/**
* 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 Integer DependentId = null;
/**
* Dependent's first name.
*/
@ApiMember(Description="Dependent's first name.", IsRequired=true)
public String FirstName = null;
/**
* Dependent's surname.
*/
@ApiMember(Description="Dependent's surname.", IsRequired=true)
public String Surname = null;
/**
* Dependent's mobile contact number.
*/
@ApiMember(Description="Dependent's mobile contact number.", IsRequired=true)
public String MobileNumber = null;
/**
* Dependent's email address.
*/
@ApiMember(Description="Dependent's email address.", IsRequired=true)
public String Email = null;
/**
* Depdendent's ID number.
*/
@ApiMember(Description="Depdendent's ID number.", IsRequired=true)
public String IdNumber = null;
public Integer getDependentId() { return DependentId; }
public DependentData setDependentId(Integer value) { this.DependentId = value; return this; }
public String getFirstName() { return FirstName; }
public DependentData setFirstName(String value) { this.FirstName = value; return this; }
public String getSurname() { return Surname; }
public DependentData setSurname(String value) { this.Surname = value; return this; }
public String getMobileNumber() { return MobileNumber; }
public DependentData setMobileNumber(String value) { this.MobileNumber = value; return this; }
public String getEmail() { return Email; }
public DependentData setEmail(String value) { this.Email = value; return this; }
public String getIdNumber() { return IdNumber; }
public DependentData setIdNumber(String value) { this.IdNumber = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>