Sanctions Search API: v2

<back to all web services

UpdateSubUser

"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 UpdateSubUserData 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 UpdateSubUserResponse {
    /** @param {{data?:UpdateSubUserData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {UpdateSubUserData}
     * @description The response data */
    data;
}
export class ArrayOfString extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class UpdateSubUserRequest {
    /** @param {{subUserName?:string,permissions?:ArrayOfString}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The user name of the sub user */
    subUserName;
    /**
     * @type {ArrayOfString}
     * @description The user names for which searches will be made available to the sub user */
    permissions;
}
export class UpdateSubUser extends BaseRequest {
    /** @param {{request?:UpdateSubUserRequest,authentication?:Authentication}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {UpdateSubUserRequest} */
    request;
}

JavaScript UpdateSubUser DTOs

PUT /subusers/update HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateSubUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <Permissions>
      <String>String</String>
    </Permissions>
    <SubUserName>String</SubUserName>
  </Request>
</UpdateSubUser>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateSubUserResponse 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>
</UpdateSubUserResponse>