| GET | /ApiRequestsPerHour |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AgentivityAPI.ServiceModel.Types
Imports AgentivityAPI.ServiceModel
Namespace Global
Namespace AgentivityAPI.ServiceModel
<DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
Public Partial Class CollectionResponse(Of TItem)
<DataMember(Order:=1)>
Public Overridable Property ResponseMetadata As ResponseMetadata
<DataMember(Order:=2, EmitDefaultValue:=false)>
Public Overridable Property ResponseReport As List(Of ApiRequestPerHour)
<DataMember(Order:=3, EmitDefaultValue:=false)>
Public Overridable Property ResponseError As AgentivityError
End Class
End Namespace
Namespace AgentivityAPI.ServiceModel.Types
<DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class AgentivityError
<DataMember>
Public Overridable Property ErrorCode As String
<DataMember>
Public Overridable Property Message As String
<DataMember>
Public Overridable Property StatusCode As String
<DataMember>
Public Overridable Property VerboseMessage As String
End Class
<DataContract(Name:="ApiRequestPerHour", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ApiRequestPerHour
<DataMember(Order:=10)>
Public Overridable Property RequestDate As Date
<DataMember(Order:=100)>
Public Overridable Property Hour0 As Integer
<DataMember(Order:=110)>
Public Overridable Property Hour1 As Integer
<DataMember(Order:=120)>
Public Overridable Property Hour2 As Integer
<DataMember(Order:=130)>
Public Overridable Property Hour3 As Integer
<DataMember(Order:=140)>
Public Overridable Property Hour4 As Integer
<DataMember(Order:=150)>
Public Overridable Property Hour5 As Integer
<DataMember(Order:=160)>
Public Overridable Property Hour6 As Integer
<DataMember(Order:=170)>
Public Overridable Property Hour7 As Integer
<DataMember(Order:=180)>
Public Overridable Property Hour8 As Integer
<DataMember(Order:=190)>
Public Overridable Property Hour9 As Integer
<DataMember(Order:=200)>
Public Overridable Property Hour10 As Integer
<DataMember(Order:=210)>
Public Overridable Property Hour11 As Integer
<DataMember(Order:=220)>
Public Overridable Property Hour12 As Integer
<DataMember(Order:=230)>
Public Overridable Property Hour13 As Integer
<DataMember(Order:=240)>
Public Overridable Property Hour14 As Integer
<DataMember(Order:=250)>
Public Overridable Property Hour15 As Integer
<DataMember(Order:=260)>
Public Overridable Property Hour16 As Integer
<DataMember(Order:=270)>
Public Overridable Property Hour17 As Integer
<DataMember(Order:=280)>
Public Overridable Property Hour18 As Integer
<DataMember(Order:=290)>
Public Overridable Property Hour19 As Integer
<DataMember(Order:=300)>
Public Overridable Property Hour20 As Integer
<DataMember(Order:=310)>
Public Overridable Property Hour21 As Integer
<DataMember(Order:=320)>
Public Overridable Property Hour22 As Integer
<DataMember(Order:=330)>
Public Overridable Property Hour23 As Integer
End Class
<DataContract(Name:="CacheMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class CacheMetadata
<DataMember(Order:=1)>
Public Overridable Property CachedAt As Date
<DataMember(Order:=2)>
Public Overridable Property CacheExpiresAt As Date
<DataMember(Order:=0)>
Public Overridable Property IsFromCache As Boolean
End Class
<DataContract(Namespace:="schemas.agentivity.com/types")>
Public Partial Class GetApiRequestsPerHour
Inherits PagingMetadata
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property DateStart As String
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property DateEnd As String
End Class
<DataContract(Name:="Metadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class PagingMetadata
'''<Summary>
'''Starting Record
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Starting Record", Name:="Offset", ParameterType:="query")>
Public Overridable Property Offset As String
'''<Summary>
'''Number of records to return (PageSize)
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Number of records to return (PageSize)", Name:="Limit", ParameterType:="query")>
Public Overridable Property Limit As String
'''<Summary>
'''Total Number of Records in a Full Reponse (if no paging)
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Total Number of Records in a Full Reponse (if no paging)", Name:="TotalRecords", ParameterType:="query")>
Public Overridable Property TotalRecords As Integer
'''<Summary>
'''Total Number of Records in this Reponse (on this page)
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Total Number of Records in this Reponse (on this page)", Name:="ResponseRecords", ParameterType:="query")>
Public Overridable Property ResponseRecords As Integer
End Class
<DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ResponseMetadata
<DataMember(Order:=0)>
Public Overridable Property Success As Boolean
<DataMember(Order:=1)>
Public Overridable Property HasCache As Boolean
<DataMember(Order:=2)>
Public Overridable Property HasPaging As Boolean
<DataMember(Order:=3, EmitDefaultValue:=false)>
Public Overridable Property CacheMetadata As CacheMetadata
<DataMember(Order:=4, EmitDefaultValue:=false)>
Public Overridable Property PagingMetadata As PagingMetadata
End Class
End Namespace
End Namespace
VB.NET GetApiRequestsPerHour 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.
GET /ApiRequestsPerHour HTTP/1.1 Host: api.agentivity.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<ResponseMetadata>
<Success>false</Success>
<HasCache>false</HasCache>
<HasPaging>false</HasPaging>
<CacheMetadata>
<IsFromCache>false</IsFromCache>
<CachedAt>0001-01-01T00:00:00</CachedAt>
<CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
</CacheMetadata>
<PagingMetadata>
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
</PagingMetadata>
</ResponseMetadata>
<ResponseReport>
<ApiRequestPerHour>
<RequestDate>0001-01-01T00:00:00</RequestDate>
<Hour0>0</Hour0>
<Hour1>0</Hour1>
<Hour2>0</Hour2>
<Hour3>0</Hour3>
<Hour4>0</Hour4>
<Hour5>0</Hour5>
<Hour6>0</Hour6>
<Hour7>0</Hour7>
<Hour8>0</Hour8>
<Hour9>0</Hour9>
<Hour10>0</Hour10>
<Hour11>0</Hour11>
<Hour12>0</Hour12>
<Hour13>0</Hour13>
<Hour14>0</Hour14>
<Hour15>0</Hour15>
<Hour16>0</Hour16>
<Hour17>0</Hour17>
<Hour18>0</Hour18>
<Hour19>0</Hour19>
<Hour20>0</Hour20>
<Hour21>0</Hour21>
<Hour22>0</Hour22>
<Hour23>0</Hour23>
</ApiRequestPerHour>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>