Foundry API

<back to all web services

GetCurrentProfileRequest

The following routes are available for this service:
GET/profile/current
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Profile;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class CurrentProfile
        : Profile
    {
        public CurrentProfile()
        {
            Roles = new List<string>{};
        }

        public virtual bool IsAuthenticated { get; set; }
        public virtual List<string> Roles { get; set; }
    }

    public partial class PersonName
    {
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
    }

    public partial class Profile
        : ProfileBasic
    {
        public virtual string DefaultOrganisationId { get; set; }
    }

    public partial class ProfileBasic
        : IIdentifiableResource
    {
        public virtual PersonName Name { get; set; }
        public virtual string DisplayName { get; set; }
        public virtual string EmailAddress { get; set; }
        public virtual string PhoneNumber { get; set; }
        public virtual string Timezone { get; set; }
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class GetOperationUnTenanted<TResponse>
        : IHasGetOptions, IGet
    {
        public virtual string Embed { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Profile
{
    public partial class GetCurrentProfileRequest
        : GetOperationUnTenanted<GetCurrentProfileResponse>
    {
    }

    public partial class GetCurrentProfileResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual CurrentProfile Profile { get; set; }
    }

}

C# GetCurrentProfileRequest DTOs

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.

GET /profile/current HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"profile":{"isAuthenticated":false,"roles":["String"],"defaultOrganisationId":"String","name":{"firstName":"String","lastName":"String"},"displayName":"String","emailAddress":"String","phoneNumber":"String","timezone":"String","id":"String"}}