| Create a sub user |
"use strict";
export class Authentication {
/** @param {{apiUserId?:string,apiUserKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API User ID provided by us when you signed up to use our API */
apiUserId;
/**
* @type {string}
* @description The API User Key provided by us when you signed up to use our API */
apiUserKey;
}
export class BaseRequest {
/** @param {{authentication?:Authentication}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {Authentication}
* @description The authentication credentials */
authentication;
}
export class ResponseError {
/** @param {{errorCode?:string,fieldName?:string,message?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
errorCode;
/** @type {string} */
fieldName;
/** @type {string} */
message;
/** @type {{ [index: string]: string; }} */
meta;
}
export class ArrayOfResponseError extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseStatus {
/** @param {{errorCode?:string,message?:string,stackTrace?:string,errors?:ArrayOfResponseError,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
errorCode;
/** @type {string} */
message;
/** @type {string} */
stackTrace;
/** @type {ArrayOfResponseError} */
errors;
/** @type {{ [index: string]: string; }} */
meta;
}
export class BaseResponse {
/** @param {{responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {ResponseStatus}
* @description The status of the response */
responseStatus;
}
export class ArrayOfUserNames extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class SubUser {
/** @param {{isMainUser?:boolean,userId?:string,userName?:string,name?:string,email?:string,isAdmin?:boolean,canResolveSearches?:boolean,canDeleteSearches?:boolean,permissions?:ArrayOfUserNames}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {boolean}
* @description Is this user the main user (i.e. the user who created the account) */
isMainUser;
/**
* @type {string}
* @description The sub user's id (GUID) */
userId;
/**
* @type {string}
* @description The sub user's UserName (i.e. the sign-in username) */
userName;
/**
* @type {string}
* @description The sub user's name */
name;
/**
* @type {string}
* @description The sub user's email address */
email;
/**
* @type {boolean}
* @description Does this sub user have admin privileges, such as managing purchases and sub users */
isAdmin;
/**
* @type {boolean}
* @description Can this sub user resolve searches (UpdateSearch) they have access to */
canResolveSearches;
/**
* @type {boolean}
* @description Can this sub user delete searches (DeleteSearch) they have access to */
canDeleteSearches;
/**
* @type {ArrayOfUserNames}
* @description The user names for which searches will be made available to the sub user */
permissions;
}
export class AddSubUserData extends BaseResponse {
/** @param {{subUser?:SubUser,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {SubUser}
* @description The sub user */
subUser;
}
export class AddSubUserResponse {
/** @param {{data?:AddSubUserData}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {AddSubUserData}
* @description The response data */
data;
}
export class AddSubUserRequest {
/** @param {{userName?:string,name?:string,email?:string,isAdmin?:boolean,canResolveSearches?:boolean,canDeleteSearches?:boolean,sendWelcomeEmail?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
userName;
/** @type {string} */
name;
/** @type {string} */
email;
/** @type {boolean} */
isAdmin;
/** @type {boolean} */
canResolveSearches;
/** @type {boolean} */
canDeleteSearches;
/** @type {boolean} */
sendWelcomeEmail;
}
export class AddSubUser extends BaseRequest {
/** @param {{request?:AddSubUserRequest,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {AddSubUserRequest} */
request;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap12 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AddSubUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<CanDeleteSearches>false</CanDeleteSearches>
<CanResolveSearches>false</CanResolveSearches>
<Email>String</Email>
<IsAdmin>false</IsAdmin>
<Name>String</Name>
<SendWelcomeEmail>false</SendWelcomeEmail>
<UserName>String</UserName>
</Request>
</AddSubUser>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AddSubUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Data>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
<SubUser>
<CanDeleteSearches>false</CanDeleteSearches>
<CanResolveSearches>false</CanResolveSearches>
<Email>String</Email>
<IsAdmin>false</IsAdmin>
<IsMainUser>false</IsMainUser>
<Name>String</Name>
<Permissions>
<UserName>String</UserName>
</Permissions>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<UserName>String</UserName>
</SubUser>
</Data>
</AddSubUserResponse>
</soap12:Body>
</soap12:Envelope>