Family Media List Read

Description

The Family MediaListRead operation returns a list of Media entities associated with an Family

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Family.svc/MediaListRead?SessionId={sessionId}&FamOgfn={famOgfn}

Content-Type: Application/xml

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/Family.svc//MediaListRead?SessionId=gl4q23cwofpshi55sg1pvc3o&FamOgfn=5747732

Request Headers

Content-Type: Application/xml

Success Response Payload

Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Code>0</Code>
  <Message>Success</Message>
  <Value i:type="ArrayOfMedia">
    <Media>
      <FileName>test.jpg</FileName>
      <FileType>jpg</FileType>
      <MediaOGFN>187578</MediaOGFN>
      <Title>grannnyat96</Title>
    </Media>
    <Media>
      <FileName>test.jpg</FileName>
      <FileType>jpg</FileType>
      <MediaOGFN>187580</MediaOGFN>
      <Title>grannny at 96</Title>
    </Media>
    <Media>
      <FileName>test.jpg</FileName>
      <FileType>jpg</FileType>
      <MediaOGFN>187582</MediaOGFN>
      <Title>grannny at 96</Title>
    </Media>
  </Value>
</Result>

Failed Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>27001</Code>
	<Message>Your developer Id does not have permissions to make this call</Message>
</Result>

Fault Response Payload

<RestFault xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<ErrorCode>551</ErrorCode>
	<FaultMessage>An unhandled exception has occurred</FaultMessage>
</RestFault>

Query String Parameters [GET]

Name	Description	Required
FamOgfn	A Onegreatfamily individual identifier. Type: UInt64 Default: None Constraints: Must be a valid individual identifier.	Yes
SessionId	The current session Id Type: string Default: None	Yes

Name

Description

Required

FamOgfn

A Onegreatfamily individual identifier.

Type: UInt64

Default: None

Constraints: Must be a valid individual identifier.

Yes

SessionId

The current session Id

Type: string

Default: None

Yes

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be an array of `Media` entities upon success. Type: array of `Media`
`HTTP Status Code`	The Web Server returns a status code which indicates if the operation was successful. Anything other than 200 should be regarded as a failure.
`HTTP Status Code` of 417	The Web Server threw an exception and contains a `RestFault` entity. Retrieve the RestFault from the Webexception response property.