DELETE | /organisations/{Id}/blocklist |
---|
export class DeleteOperationUnTenanted<TResponse> implements IDelete
{
public constructor(init?: Partial<DeleteOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}
export class OrganisationNotificationSettings implements IIdentifiableResource
{
public warningNotificationRoles?: string[];
public jobFinishedNotificationRoles?: string[];
public userIdBlockList?: string[];
public id?: string;
public constructor(init?: Partial<OrganisationNotificationSettings>) { (Object as any).assign(this, init); }
}
export class BlockListResponse
{
public responseStatus?: ResponseStatus;
public notificationSettings?: OrganisationNotificationSettings;
public constructor(init?: Partial<BlockListResponse>) { (Object as any).assign(this, init); }
}
export class RemoveUserFromBlockListRequest extends DeleteOperationUnTenanted<BlockListResponse>
{
public id?: string;
public userId?: string;
public constructor(init?: Partial<RemoveUserFromBlockListRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript RemoveUserFromBlockListRequest 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.
DELETE /organisations/{Id}/blocklist HTTP/1.1 Host: foundrystage-api-app.azurewebsites.net Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <BlockListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Organisations"> <NotificationSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources"> <d2p1:Id>String</d2p1:Id> <d2p1:JobFinishedNotificationRoles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>String</d3p1:string> </d2p1:JobFinishedNotificationRoles> <d2p1:UserIdBlockList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>String</d3p1:string> </d2p1:UserIdBlockList> <d2p1:WarningNotificationRoles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>String</d3p1:string> </d2p1:WarningNotificationRoles> </NotificationSettings> <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> </BlockListResponse>