Foundry API

ListOrganisationsForCallerRequest

The following routes are available for this service:
GET	/organisations

**SearchOperationUnTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required
Distinct	form	string	No
Limit	form	int?	No
Offset	form	int?	No
Sort	form	string	No
Filter	form	string	No

**GetOperationUnTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
Embed	form	string	No

**ListOrganisationsForCallerResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Organisations	form	List<Organisation>	No

**SearchOperationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Metadata	form	SearchMetadata	No

**SearchMetadata** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
Limit	form	int	No
Offset	form	int	No
Sort	form	Sorting	No
Filter	form	Filtering	No

**Sorting** Parameters:
Name	Parameter	Data Type	Required	Description
By	form	string	No
Direction	form	SortDirection	No

**SortDirection** Enum:
Ascending
Descending

**Filtering** Parameters:
Name	Parameter	Data Type	Required	Description
Fields	form	List<string>	No

**Organisation** Parameters:
Name	Parameter	Data Type	Required
DisplayName	form	string	No
Owners	form	List<string>	No
IsDefault	form	bool?	No
Id	form	string	No
ForceTwoFactor	form	bool	No

**ListOrganisationsForCallerResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Organisations	form	List<Organisation>	No

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.

GET /organisations HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	organisations: 
	[
		{
			displayName: String,
			owners: 
			[
				String
			],
			isDefault: False,
			id: String,
			forceTwoFactor: False
		}
	],
	metadata: 
	{
		total: 0,
		limit: 0,
		offset: 0,
		sort: 
		{
			by: String,
			direction: Ascending
		},
		filter: 
		{
			fields: 
			[
				String
			]
		}
	}
}