Sanctions Search API: v2

<back to all web services

GetSubUser

// @DataContract
export class Authentication
{
    /** @description The API User ID provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserId: string;

    /** @description The API User Key provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserKey: string;

    public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseRequest implements IBaseRequest
{
    /** @description The authentication credentials */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public authentication: Authentication;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseError
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public fieldName: string;

    // @DataMember(Order=3)
    public message: string;

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}

export class ArrayOfResponseError extends Array<ResponseError>
{

    public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public message: string;

    // @DataMember(Order=3)
    public stackTrace: string;

    // @DataMember(Order=4)
    public errors: ArrayOfResponseError;

    // @DataMember(Order=5)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

export class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
    /** @description The status of the response */
    // @ApiMember(Description="The status of the response")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export class ArrayOfUserNames extends Array<string>
{

    public constructor(init?: Partial<ArrayOfUserNames>) { super(); (Object as any).assign(this, init); }
}

export class SubUser
{
    /** @description Is this user the main user (i.e. the user who created the account) */
    // @ApiMember(Description="Is this user the main user (i.e. the user who created the account)")
    public isMainUser: boolean;

    /** @description The sub user's id (GUID) */
    // @ApiMember(Description="The sub user's id (GUID)")
    public userId: string;

    /** @description The sub user's UserName (i.e. the sign-in username) */
    // @ApiMember(Description="The sub user's UserName (i.e. the sign-in username)")
    public userName: string;

    /** @description The sub user's name */
    // @ApiMember(Description="The sub user's name")
    public name: string;

    /** @description The sub user's email address */
    // @ApiMember(Description="The sub user's email address")
    public email: string;

    /** @description Does this sub user have admin privileges, such as managing purchases and sub users */
    // @ApiMember(Description="Does this sub user have admin privileges, such as managing purchases and sub users")
    public isAdmin: boolean;

    /** @description Can this sub user resolve searches (UpdateSearch) they have access to */
    // @ApiMember(Description="Can this sub user resolve searches (UpdateSearch) they have access to")
    public canResolveSearches: boolean;

    /** @description Can this sub user delete searches (DeleteSearch) they have access to */
    // @ApiMember(Description="Can this sub user delete searches (DeleteSearch) they have access to")
    public canDeleteSearches: boolean;

    /** @description The user names for which searches will be made available to the sub user */
    // @ApiMember(Description="The user names for which searches will be made available to the sub user")
    public permissions: ArrayOfUserNames;

    public constructor(init?: Partial<SubUser>) { (Object as any).assign(this, init); }
}

export class GetSubUserData extends BaseResponse
{
    /** @description The sub users */
    // @ApiMember(Description="The sub users")
    public subUser: SubUser;

    public constructor(init?: Partial<GetSubUserData>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class GetSubUserResponse
{
    /** @description The response data */
    // @DataMember
    // @ApiMember(Description="The response data")
    public data: GetSubUserData;

    public constructor(init?: Partial<GetSubUserResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetSubUser extends BaseRequest
{
    /** @description The user name of the sub user */
    // @DataMember
    // @ApiMember(Description="The user name of the sub user", ParameterType="query")
    public subUserName: string;

    /** @description The user id of the sub user */
    // @DataMember
    // @ApiMember(Description="The user id of the sub user", ParameterType="query")
    public subUserId?: string;

    public constructor(init?: Partial<GetSubUser>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetSubUser DTOs

GET /subusers/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml

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

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