Record Endpoints
      Back to home
      1. Knowledge Base
      2. Developers
      3. Record Endpoints

      GET imcc/v1/record/search 📰

      Search for your records and return metadata and media information

      Resource URL

      https://{MEDIACONTROLCENTRE_HOST}[:PORT]/imcc/v1/record/search

      Resource Information

      Response formats XML
      Requires authentication? Yes
      Required scope(s) readUsersData

       

       

      Parameters

      Arguments should be supplied as query parameters in the manner shown below

       

      query

      Required

      /imcc/v1/record/search?query=WHERE {field}={"Query"}
       

      timeout

      Optional

      ?timeout={Timeout in seconds}

      numrecords

      Optional
      &numRecords=m (number of records of the search to return)

      start

      Optional

      &start={index of first record in the results that you want returned}

      MUST be used with

      searchID

      Optional

      &searchID={Search ID} 

      NOTE: searchID will be returned in the response to call for first page of results (and each subsequent call there after).

      includeMedia

      Optional

      &includeMedia=true

      This optional parameter returns Media Objects with the call

      Example REST request

      https://{MEDIACONTROLCENTRE_HOST}[:PORT]/imcc/v1/record/search?query=WHERE Title="Red Car"

      Example Response

      Returns success, or an error response on failure.

      Response on success

      <?xml version="1.0" encoding="UTF-8"?>
      <Records>
          <SearchID>F4DCC517-83DA-4ce9-9AD2-24E9EB3444E2</SearchID>
          <TotalHits>1</TotalHits>
          <ImagenRecord ID="49" CanEdit="false">
              <Fields>
                  <guid>9A9A8A08-4A82-4f9c-8CC1-0C93631C5EC9</guid>
                  <Title>Red Car</Title>
                  <Date></Date>
                  <Summary></Summary>
                  <imagenLastRecordChange>2022-03-28 10:50:58</imagenLastRecordChange>
              </Fields>
          </ImagenRecord>
      </Records>

      Response on failure