| GET | /organisations |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Organisations;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces;
using Application.Interfaces.Resources;
namespace Application.Interfaces
{
public partial class Filtering
{
public Filtering()
{
Fields = new List<string>{};
}
public virtual List<string> Fields { get; set; }
}
public partial class SearchMetadata
{
public virtual int Total { get; set; }
public virtual int Limit { get; set; }
public virtual int Offset { get; set; }
public virtual Sorting Sort { get; set; }
public virtual Filtering Filter { get; set; }
}
public enum SortDirection
{
Ascending,
Descending,
}
public partial class Sorting
{
public virtual string By { get; set; }
public virtual SortDirection Direction { get; set; }
}
}
namespace Application.Interfaces.Resources
{
public partial class Organisation
: IIdentifiableResource
{
public Organisation()
{
Owners = new List<string>{};
}
public virtual string DisplayName { get; set; }
public virtual List<string> Owners { get; set; }
public virtual bool? IsDefault { get; set; }
public virtual string Id { get; set; }
public virtual bool ForceTwoFactor { get; set; }
}
}
namespace Infrastructure.Api.Interfaces.ServiceOperations
{
public partial class GetOperationUnTenanted<TResponse>
: IHasGetOptions, IGet
{
public virtual string Embed { get; set; }
}
public partial class SearchOperationResponse
{
public virtual SearchMetadata Metadata { get; set; }
}
public partial class SearchOperationUnTenanted<TResponse>
: GetOperationUnTenanted<TResponse>, IHasSearchOptions
{
public virtual string Distinct { get; set; }
public virtual int? Limit { get; set; }
public virtual int? Offset { get; set; }
public virtual string Sort { get; set; }
public virtual string Filter { get; set; }
}
}
namespace Infrastructure.Api.Interfaces.ServiceOperations.Organisations
{
public partial class ListOrganisationsForCallerRequest
: SearchOperationUnTenanted<ListOrganisationsForCallerResponse>
{
}
public partial class ListOrganisationsForCallerResponse
: SearchOperationResponse
{
public ListOrganisationsForCallerResponse()
{
Organisations = new List<Organisation>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<Organisation> Organisations { get; set; }
}
}
C# ListOrganisationsForCallerRequest DTOs
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.
GET /organisations HTTP/1.1 Host: staging-api.foundrylab.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ListOrganisationsForCallerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Organisations">
<Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">
<d2p1:Filter>
<d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:Fields>
</d2p1:Filter>
<d2p1:Limit>0</d2p1:Limit>
<d2p1:Offset>0</d2p1:Offset>
<d2p1:Sort>
<d2p1:By>String</d2p1:By>
<d2p1:Direction>Ascending</d2p1:Direction>
</d2p1:Sort>
<d2p1:Total>0</d2p1:Total>
</Metadata>
<Organisations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
<d2p1:Organisation>
<d2p1:DisplayName>String</d2p1:DisplayName>
<d2p1:ForceTwoFactor>false</d2p1:ForceTwoFactor>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsDefault>false</d2p1:IsDefault>
<d2p1:Owners xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:Owners>
</d2p1:Organisation>
</Organisations>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</ListOrganisationsForCallerResponse>