| POST | /bulksearches/list | Get all bulk searches |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SanctionsSearch.Api2.ServiceModel.Operations.BulkSearches
Imports SanctionsSearch.Api2.ServiceModel.Operations.Base
Imports SanctionsSearch.Api2.ServiceModel.Types
Namespace Global
Namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
Public Partial Class ArrayOfResponseError
Inherits List(Of ResponseError)
End Class
<DataContract>
Public Partial Class BaseRequest
Implements IBaseRequest
'''<Summary>
'''The authentication credentials
'''</Summary>
<DataMember>
<ApiMember(Description:="The authentication credentials", IsRequired:=true, ParameterType:="header, body")>
Public Overridable Property Authentication As Authentication
End Class
Public Partial Class BaseResponse
Implements IBaseDataResponse
Implements IHasResponseStatus
'''<Summary>
'''The status of the response
'''</Summary>
<ApiMember(Description:="The status of the response")>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
<DataContract>
Public Partial Class ResponseError
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property ErrorCode As String
<DataMember(Order:=2)>
Public Overridable Property FieldName As String
<DataMember(Order:=3)>
Public Overridable Property Message As String
<DataMember(Order:=4)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
<DataContract>
Public Partial Class ResponseStatus
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property ErrorCode As String
<DataMember(Order:=2)>
Public Overridable Property Message As String
<DataMember(Order:=3)>
Public Overridable Property StackTrace As String
<DataMember(Order:=4)>
Public Overridable Property Errors As ArrayOfResponseError
<DataMember(Order:=5)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
End Namespace
Namespace SanctionsSearch.Api2.ServiceModel.Operations.BulkSearches
<DataContract>
Public Partial Class GetBulkSearchHistory
Inherits BaseRequest
<DataMember>
Public Overridable Property Request As GetBulkSearchHistoryRequest
End Class
Public Partial Class GetBulkSearchHistoryData
Inherits BaseResponse
Public Overridable Property BulkSearchList As ArrayOfBulkSearchStatus
Public Overridable Property CurrentPageNum As Integer
Public Overridable Property MaxPageNum As Integer
Public Overridable Property TotalBulkSearches As Integer
Public Overridable Property PageSize As Integer
End Class
Public Partial Class GetBulkSearchHistoryRequest
Public Overridable Property SubUserName As String
Public Overridable Property Page As Integer
Public Overridable Property SortOrder As String
'''<Summary>
'''The user id to filter on, in string format (GUID)
'''</Summary>
<ApiMember(Description:="The user id to filter on, in string format (GUID)")>
Public Overridable Property WhereUserId As String
Public Overridable Property WhereDateFrom As Nullable(Of Date)
Public Overridable Property WhereDateTo As Nullable(Of Date)
Public Overridable Property WhereId As Nullable(Of Integer)
Public Overridable Property PageSize As Integer
End Class
<DataContract>
Public Partial Class GetBulkSearchHistoryResponse
<DataMember>
Public Overridable Property Data As GetBulkSearchHistoryData
End Class
End Namespace
Namespace SanctionsSearch.Api2.ServiceModel.Types
Public Partial Class ArrayOfBulkSearchStatus
Inherits List(Of BulkSearchStatus)
End Class
<DataContract>
Public Partial Class Authentication
'''<Summary>
'''The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
'''</Summary>
<DataMember>
<ApiMember(Description:="The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)", IsRequired:=true, ParameterType:="header, body")>
Public Overridable Property ApiUserId As String
'''<Summary>
'''The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
'''</Summary>
<DataMember>
<ApiMember(Description:="The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)", IsRequired:=true, ParameterType:="header, body")>
Public Overridable Property ApiUserKey As String
'''<Summary>
'''The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).
'''</Summary>
<DataMember>
<ApiMember(Description:="The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).", ParameterType:="header, body")>
Public Overridable Property UserId As String
End Class
Public Partial Class BulkSearchStatus
Public Overridable Property BulkSearchId As Integer
Public Overridable Property Success As Boolean
Public Overridable Property Status As String
Public Overridable Property Total As Integer
Public Overridable Property Message As String
Public Overridable Property Processed As Integer
Public Overridable Property IsPepSearch As Boolean
Public Overridable Property IsSanctionsSearch As Boolean
Public Overridable Property TotalPep As Integer
Public Overridable Property ProcessedPep As Integer
Public Overridable Property TotalSanctions As Integer
Public Overridable Property ProcessedSanctions As Integer
End Class
End Namespace
End Namespace
VB.NET GetBulkSearchHistory 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.
POST /bulksearches/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetBulkSearchHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
<UserId>String</UserId>
</Authentication>
<Request>
<WhereUserId>String</WhereUserId>
</Request>
</GetBulkSearchHistory>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetBulkSearchHistoryResponse 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>
<BulkSearchList>
<BulkSearch>
<BulkSearchId>0</BulkSearchId>
<IsPepSearch>false</IsPepSearch>
<IsSanctionsSearch>false</IsSanctionsSearch>
<Message>String</Message>
<Processed>0</Processed>
<ProcessedPep>0</ProcessedPep>
<ProcessedSanctions>0</ProcessedSanctions>
<Status>String</Status>
<Success>false</Success>
<Total>0</Total>
<TotalPep>0</TotalPep>
<TotalSanctions>0</TotalSanctions>
</BulkSearch>
</BulkSearchList>
<CurrentPageNum>0</CurrentPageNum>
<MaxPageNum>0</MaxPageNum>
<PageSize>0</PageSize>
<TotalBulkSearches>0</TotalBulkSearches>
</Data>
</GetBulkSearchHistoryResponse>