Cdn API - CPG Source

<back to all web services

CdnUserApiUsageReportRequest

Cdn.Api

The following routes are available for this service:
GET/CdnUserApiUsageReportRequest
CdnUserApiUsageReportRequest Parameters:
NameParameterData TypeRequiredDescription
CdnUserIdquerystringNo
LoginNamequerystringNo
ApiCallquerystringNo
FromDatequerystringNo
ToDatequerystringNo
PagequeryintNo
SkipqueryintNo
TakequeryintNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
CdnUserApiUsageReportResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<CdnUserApiAccessLogsDto>No
CdnUsersformList<CdnUserDto>No
PageformintNo
PagesformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
CdnUserApiAccessLogsDto Parameters:
NameParameterData TypeRequiredDescription
CdnUserIdformlongNo
ApiCallformstringNo
HitsformintNo
CdnUserDto Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
EmailAddressformstringNo
LoginNameformstringNo
PasswordformstringNo
AllowBettyAccessformboolNo
CatalogAccessformboolNo
CatalogReadOnlyformboolNo
DateCreatedformDateTimeNo
ApiKeyformstringNo
ApiTokenformstringNo
RolesformList<XBettyRoleDto>No
CatalogApiRolesformList<XCatalogApiRoleDto>No
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
XBettyRoleDto Parameters:
NameParameterData TypeRequiredDescription
RoleNameformstringNo
DescriptionformstringNo
XCdnUserRoleFeaturesformList<XCdnUserRoleFeatureDto>No
XCdnUserRoleFeatureDto Parameters:
NameParameterData TypeRequiredDescription
FeatureTitleformstringNo
SortOrderformintNo
XCatalogApiRoleDto Parameters:
NameParameterData TypeRequiredDescription
RoleNameformstringNo
DescriptionformstringNo
CallsAllowedformstringNo
CdnUserApiUsageReportResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<CdnUserApiAccessLogsDto>No
CdnUsersformList<CdnUserDto>No
PageformintNo
PagesformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /CdnUserApiUsageReportRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CdnUserApiUsageReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <CdnUsers xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Dto">
    <d2p1:CdnUserDto>
      <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_LastModBy_x003E_k__BackingField>String</d2p1:_x003C_LastModBy_x003E_k__BackingField>
      <d2p1:_x003C_LastMod_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastMod_x003E_k__BackingField>
      <d2p1:AllowBettyAccess>false</d2p1:AllowBettyAccess>
      <d2p1:ApiKey>String</d2p1:ApiKey>
      <d2p1:ApiToken>String</d2p1:ApiToken>
      <d2p1:CatalogAccess>false</d2p1:CatalogAccess>
      <d2p1:CatalogApiRoles>
        <d2p1:XCatalogApiRoleDto>
          <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
          <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
          <d2p1:_x003C_LastModBy_x003E_k__BackingField>String</d2p1:_x003C_LastModBy_x003E_k__BackingField>
          <d2p1:_x003C_LastMod_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastMod_x003E_k__BackingField>
          <d2p1:CallsAllowed>String</d2p1:CallsAllowed>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:RoleName>String</d2p1:RoleName>
        </d2p1:XCatalogApiRoleDto>
      </d2p1:CatalogApiRoles>
      <d2p1:CatalogReadOnly>false</d2p1:CatalogReadOnly>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:EmailAddress>String</d2p1:EmailAddress>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:LoginName>String</d2p1:LoginName>
      <d2p1:Password>String</d2p1:Password>
      <d2p1:Roles>
        <d2p1:XBettyRoleDto>
          <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
          <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
          <d2p1:_x003C_LastModBy_x003E_k__BackingField>String</d2p1:_x003C_LastModBy_x003E_k__BackingField>
          <d2p1:_x003C_LastMod_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastMod_x003E_k__BackingField>
          <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
          <d2p1:_x003C_RoleName_x003E_k__BackingField>String</d2p1:_x003C_RoleName_x003E_k__BackingField>
          <d2p1:_x003C_XCdnUserRoleFeatures_x003E_k__BackingField>
            <d2p1:XCdnUserRoleFeatureDto i:nil="true" />
          </d2p1:_x003C_XCdnUserRoleFeatures_x003E_k__BackingField>
        </d2p1:XBettyRoleDto>
      </d2p1:Roles>
    </d2p1:CdnUserDto>
  </CdnUsers>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Dto">
    <d2p1:CdnUserApiAccessLogsDto>
      <d2p1:ApiCall>String</d2p1:ApiCall>
      <d2p1:CdnUserId>0</d2p1:CdnUserId>
      <d2p1:Hits>0</d2p1:Hits>
    </d2p1:CdnUserApiAccessLogsDto>
  </Data>
  <Page>0</Page>
  <Pages>0</Pages>
</CdnUserApiUsageReportResponse>