Cdn API - CPG Source

<back to all web services

CdnUserRequest

Cdn.Api

CdnUserRequest Parameters:
NameParameterData TypeRequiredDescription
ApiOnlybodyboolNo
CatalogOnlybodyboolNo
PagebodyintNo
SkipbodyintNo
TakebodyintNo
FirstNamebodystringNo
LastNamebodystringNo
EmailAddressbodystringNo
LoginNamebodystringNo
PasswordbodystringNo
AllowBettyAccessbodyboolNo
CatalogAccessbodyboolNo
CatalogReadOnlybodyboolNo
ActivebodyboolNo
DateCreatedbodyDateTimeNo
LastModbodyDateTimeNo
LastModBybodystringNo
ApiKeybodystringNo
ApiTokenbodystringNo
Rolesbodylong[]No
CatalogApiRolesbodylong[]No
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
CdnUserResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<CdnUserDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
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
CdnUserResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<CdnUserDto>No

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

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: cdnapidev.greysheet.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<CdnUserRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <Id>0</Id>
  <OrderBy xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OrderBy>
  <OrderDirections>
    <SortOrders>Asc</SortOrders>
  </OrderDirections>
  <Active>false</Active>
  <AllowBettyAccess>false</AllowBettyAccess>
  <ApiKey>String</ApiKey>
  <ApiOnly>false</ApiOnly>
  <ApiToken>String</ApiToken>
  <CatalogAccess>false</CatalogAccess>
  <CatalogApiRoles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </CatalogApiRoles>
  <CatalogOnly>false</CatalogOnly>
  <CatalogReadOnly>false</CatalogReadOnly>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <EmailAddress>String</EmailAddress>
  <FirstName>String</FirstName>
  <LastMod>0001-01-01T00:00:00</LastMod>
  <LastModBy>String</LastModBy>
  <LastName>String</LastName>
  <LoginName>String</LoginName>
  <Page>0</Page>
  <Password>String</Password>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Roles>
  <Skip>0</Skip>
  <Take>0</Take>
</CdnUserRequest>

    </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<CdnUserResponse 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>
  <Data 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>
  </Data>
</CdnUserResponse>

    </soap12:Body>
</soap12:Envelope>