Cdn API - CPG Source

<back to all web services

PhoneRequest

Cdn.Api

PhoneRequest Parameters:
NameParameterData TypeRequiredDescription
IdbodylongNo
PhoneNumberbodystringNo
ExtensionbodystringNo
LabelbodystringNo
IsPrimarybodyboolNo
IsDealerDirectorybodyboolNo
IsCdnxbodyboolNo
ActivebodyboolNo
LastModbodyDateTimeNo
LastModBybodystringNo
CustomerIDbodylongNo
OrganizationIdbodylongNo
PhoneResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<PhoneDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
PhoneDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PhoneNumberformstringNo
PhoneNumberDisplayformstringNo
ExtensionformstringNo
LabelformstringNo
IsPrimaryformboolNo
IsDealerDirectoryformboolNo
IsCdnxformboolNo
CustomerIDformlongNo
OrganizationIdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo

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

HTTP + SOAP11

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

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

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

<PhoneRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <Active>false</Active>
  <CustomerID>0</CustomerID>
  <Extension>String</Extension>
  <Id>0</Id>
  <IsCdnx>false</IsCdnx>
  <IsDealerDirectory>false</IsDealerDirectory>
  <IsPrimary>false</IsPrimary>
  <Label>String</Label>
  <LastMod>0001-01-01T00:00:00</LastMod>
  <LastModBy>String</LastModBy>
  <OrganizationId>0</OrganizationId>
  <PhoneNumber>String</PhoneNumber>
</PhoneRequest>

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

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

<PhoneResponse 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:PhoneDto>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:CustomerID>0</d2p1:CustomerID>
      <d2p1:Extension>String</d2p1:Extension>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsCdnx>false</d2p1:IsCdnx>
      <d2p1:IsDealerDirectory>false</d2p1:IsDealerDirectory>
      <d2p1:IsPrimary>false</d2p1:IsPrimary>
      <d2p1:Label>String</d2p1:Label>
      <d2p1:LastMod>0001-01-01T00:00:00</d2p1:LastMod>
      <d2p1:LastModBy>String</d2p1:LastModBy>
      <d2p1:OrganizationId>0</d2p1:OrganizationId>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:PhoneNumberDisplay>String</d2p1:PhoneNumberDisplay>
    </d2p1:PhoneDto>
  </Data>
</PhoneResponse>

    </soap:Body>
</soap:Envelope>