| POST | /organisations/{Id}/blocklist |
|---|
export class PostOperationUnTenanted<TResponse> implements IPost
{
public constructor(init?: Partial<PostOperationUnTenanted<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 AddUserToBlockListRequest extends PostOperationUnTenanted<BlockListResponse>
{
public id?: string;
public userId?: string;
public constructor(init?: Partial<AddUserToBlockListRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript AddUserToBlockListRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /organisations/{Id}/blocklist HTTP/1.1
Host: foundrystage-api-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
userId: String
}
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
}
},
notificationSettings:
{
warningNotificationRoles:
[
String
],
jobFinishedNotificationRoles:
[
String
],
userIdBlockList:
[
String
],
id: String
}
}