GetCelebrityDetails

Note: The information returned by this request is also returned by requests offered in our Name API Version 1.1. Because future API development around this information will be focused on the Name API, we now recommend using the Name API for future application development instead of this request.

GetCelebrityDetails returns information about a celebrity and can optionally include a schedule of upcoming broadcast appearances.

To include upcoming broadcast appearances, specify the ServiceId and then limit the results with the following optional parameters:

• Duration
• SourceId
• StartDate
• InProgress

This request returns a large amount of data. To speed data transmission, do the following:

• Request only data that you need to immediately display.
• Request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.

Syntax

The following is a sample SOAP 1.2 request with placeholders. Your application development environment needs to replace the placeholders with actual values.

POST /v9/listingsservice.asmx HTTP/1.1
Host: api.rovicorp.com
Content-Type: application/soap+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:Header>
    <AuthHeader xmlns="http://api.rovicorp.com/v9/common/types">
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <GetCelebrityDetails xmlns="http://api.rovicorp.com/v9/listings">
      <request>
        <Locale>string</Locale>
        <CreditHandle>
          <Id>string</Id>
          <ProviderId>int</ProviderId>
        </CreditHandle>
        <MetaData>
          <CelebrityMetaData>All or None or Biography or AKAs or Relations or Credits or Factsheets or Awards or Images</CelebrityMetaData>
          <CelebrityMetaData>All or None or Biography or AKAs or Relations or Credits or Factsheets or Awards or Images</CelebrityMetaData>
        </MetaData>
        <Format>PlainText or HTML</Format>
        <ServiceId>int</ServiceId>
        <StartDate>dateTime</StartDate>
        <Duration>int</Duration>
        <InProgress>boolean</InProgress>
        <SourceFilter>
          <Sources>
            <SourceId>int</SourceId>
            <SourceId>int</SourceId>
          </Sources>
          <Include>HD or PPV or Music</Include>
          <Excludes>
            <Exclude>HD or PPV or Music</Exclude>
            <Exclude>HD or PPV or Music</Exclude>
          </Excludes>
        </SourceFilter>
        <TitleType>int</TitleType>
        <CopyType>int</CopyType>
        <Image>
          <ImageUrl>string</ImageUrl>
          <ImageUseType>Logo or HeroImage or Thumbnail</ImageUseType>
          <ImageId>int</ImageId>
          <ImageTitle>string</ImageTitle>
          <ImageCaption>string</ImageCaption>
          <ObjectId>string</ObjectId>
          <ObjectType>Program or Credit or Source</ObjectType>
          <ObjectName>string</ObjectName>
          <Relevancy>boolean</Relevancy>
          <ImageCredit>string</ImageCredit>
          <ImageCreditDisplay>boolean</ImageCreditDisplay>
          <ImageCastWeight>float</ImageCastWeight>
          <ImageZoomLevel>1 or 2 or 3 or 4 or 5</ImageZoomLevel>
          <ImageHeadcount>int</ImageHeadcount>
          <ImageType>string</ImageType>
          <ImageFormat>jpg or png or gif or bmp</ImageFormat>
          <ImageHorizontalResolution>int</ImageHorizontalResolution>
          <ImageVerticalResolution>int</ImageVerticalResolution>
          <ImageMaintainAspectFlag>boolean</ImageMaintainAspectFlag>
          <ImageExpiryDateTime>dateTime</ImageExpiryDateTime>
          <LastUpdate>dateTime</LastUpdate>
          <ImageFormatId>int</ImageFormatId>
          <Orientation>string</Orientation>
          <AspectRatio>string</AspectRatio>
          <ImageOwner>string</ImageOwner>
          <ParentImageId>int</ParentImageId>
          <MaxImageScale>float</MaxImageScale>
        </Image>
        <IncludeCreditsForEpisodes>boolean</IncludeCreditsForEpisodes>
        <ImageCount>int</ImageCount>
        <ThisLocaleOnly>boolean</ThisLocaleOnly>
      </request>
    </GetCelebrityDetails>
  </soap12:Body>
</soap12:Envelope>

Request Example 1 »

Request a personal and professional overview for Ice-T.

Request Example 2 »

Request a schedule for the shows that Ice-T is appearing in over the next week on Time Warner Cable in Beverly Hills, California.

Request Example 3 »

Request the list of credits and awards for Mark Harmon, including credits for episodes in a series.

Request Example 4 »

Request up to 25 JPG images of Ice-T alone that fit a bounding box of 240 by 320 pixels.

Request Example 5 »

Request up to 50 different sizes and formats of the last image that was returned in Request Example 4, which is titled Leprechaun in the Hood.

Request Parameters

Response

Response Header

Response for GetCelebrityDetails

Response Example

The following is a sample SOAP 1.2 response with placeholders that show the type of content returned in an actual response.

HTTP/1.1 200 OK
Content-Type: application/soap+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>
    <GetCelebrityDetailsResponse xmlns="http://api.rovicorp.com/v9/listings">
      <GetCelebrityDetailsResult>
        <Celebrity DataAvailabilityFlags="int">
          <CreditHandle>
            <Id>string</Id>
            <ProviderId>int</ProviderId>
          </CreditHandle>
          <CreditName>string</CreditName>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <BirthName>string</BirthName>
          <BirthPlace>string</BirthPlace>
          <DateOfBirth>string</DateOfBirth>
          <DateOfDeath>string</DateOfDeath>
          <Gender>string</Gender>
          <Zodiac>string</Zodiac>
          <Profession>string</Profession>
          <HighSchool>string</HighSchool>
          <College>string</College>
          <Description>string</Description>
          <Factsheets>
            <Factsheet xsi:nil="true" />
            <Factsheet xsi:nil="true" />
          </Factsheets>
          <Awards>
            <Award xsi:nil="true" />
            <Award xsi:nil="true" />
          </Awards>
          <AKAs>
            <AKA xsi:nil="true" />
            <AKA xsi:nil="true" />
          </AKAs>
          <Relatives>
            <Relative xsi:nil="true" />
            <Relative xsi:nil="true" />
          </Relatives>
          <Credits>
            <CelebrityCredit xsi:nil="true" />
            <CelebrityCredit xsi:nil="true" />
          </Credits>
          <Images>
            <Image xsi:nil="true" />
            <Image xsi:nil="true" />
          </Images>
          <IsCelebrity>boolean</IsCelebrity>
        </Celebrity>
        <Schedule>
          <Locale>string</Locale>
          <ServiceId>int</ServiceId>
          <Name>string</Name>
          <ServiceType>string</ServiceType>
          <StartDate>dateTime</StartDate>
          <Duration>int</Duration>
          <TimeZones>
            <TimeZoneInfo xsi:nil="true" />
            <TimeZoneInfo xsi:nil="true" />
          </TimeZones>
          <Airings>
            <ListingsAiring xsi:nil="true" />
            <ListingsAiring xsi:nil="true" />
          </Airings>
        </Schedule>
      </GetCelebrityDetailsResult>
    </GetCelebrityDetailsResponse>
  </soap12:Body>
</soap12:Envelope>

Error Codes

See Also

• Common Framework

↑ Top