defaultheader

GET updateHifive

Get data of one hifive object for a update.

Parameters

Parameters Detail
format
optional		 Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for GET update

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/updateHifive/{id}

Access Permission

Access to update data varies base on system setting. See Authentication for detail on authentication.

Private WebStorms: Requester must authenticate to get data.

Public WebStorms: No authentication required to get data.

Errors

  • Invalid object ID or you don't have access to this object

Example Request

  • Method: GET
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

  • URL: https://example.brightidea.com/api3/updateHifive/0A3835CD-766F-4720-9A54-BB7F7E5EE178

     {
    "updateHifive": {
        "id": "756A7FE8-5BEF-455E-903F-D95BDD81464C",
        "date_created": "2013-04-22 15:05:20.333",
        "update_id": "E1906058-51AB-4A65-915B-DF39820EC5A7",
        "member": {
            "id": "866144B1-E302-42EF-AF80-75DE988885AE",
            "screen_name": "John Doe",
            "first_name": "John",
            "last_name": "Doe",
            "job_title": "Sales",
            "address": "123 fake street",
            "phone": "123 456-789",
            "mobile_phone": "987 654-3210",
            "external_user_id": null,
            "skills": "Selling Software",
            "work_history": "Worked at sales.com",
            "photo_url": "https://example.brightideatest.com/api3/file/02F11D0E-BA74-4A7D-B1BE-4F7F651B2507?format=binary&thumb_size=100",
            "date_created": "2013-03-07 19:09:54.563",
            "date_modified": "2013-04-18 13:14:21.067",
            "photo_file_id": "02F11D0E-BA74-4A7D-B1BE-4F7F651B2507"
        }
    }
}




LIST updateHifive

Get data on a list of hifive objects for an update. Objects are order by created date descending by default.

On retrieving large set of data, requester should use pagination parameters such as page and page_size to manage multiple requests.

Parameters

Parameters Detail
id
optional		 Filter return by updateHifive ID.
Sample value: "11111111-1111-1111-1111-111111111111"
update_id
optional		 Filter return by update ID. Update is parent to updateHifive
Sample value: "11111111-1111-1111-1111-111111111111"
date_created
optional		 Filter return by updateHifive created date. Response contains all ideas created within the 24 hours of the specified date
Sample value: "12/06/2009"
member_id
optional		 Filter return by ID of updateHifive creator
Sample value: "11111111-1111-1111-1111-111111111111"
campaign_id
optional		 Filter return by ID of a campaign
Sample value: "11111111-1111-1111-1111-111111111111"
page_size
optional		 Specifies number of records returns per page. Default: 20. Minimum: 1. Maximum: 100
Sample value: 50
page
optional		 Specifies which page of records to return. Default: 1. Minimum: 1. Maximum: {page_count}
Sample value: 5
order
optional		 A SQL style string that specifies the order the records should return in.
Sample value: "date_created ASC".
Accepted attributes: "date_created"
format
optional		 Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for LIST updateHifive

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/updateHifive

Access Permission

Access to update data varies base on system setting. See Authentication for detail on authentication.

Private WebStorms: Requester must authenticate to get data.

Public WebStorms: No authentication required to get data.

Errors

  • Invalid object ID or you don't have access to this object

Example Request

  • Method: GET
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

  • URL: https://example.brightidea.com/api3/updateHifive?campaign_id=0A140858-AD8A-4F97-9926-D80AD156A130&page_size=2

    {
    "updateHifive_list": [
        {
            "id": "0D5FC50E-45D1-4DF0-8734-52E0EBA6F5BB",
            "date_created": "2013-04-22 15:23:05.247",
            "update_id": "6E9A73CC-03DA-463D-9BD9-322FB7875772",
            "member": {
                "id": "866144B1-E302-42EF-AF80-75DE988885AE",
                "screen_name": "John Doe",
                "first_name": "John",
                "last_name": "Doe",
                "job_title": "Sales",
                "address": "123 fake street",
                "phone": "123 456-789",
                "mobile_phone": "987 654-3210",
                "external_user_id": null,
                "skills": "Selling Software",
                "work_history": "Worked at sales.com",
                "photo_url": "https://example.brightideatest.com/api3/file/02F11D0E-BA74-4A7D-B1BE-4F7F651B2507?format=binary&thumb_size=100",
                "date_created": "2013-03-07 19:09:54.563",
                "date_modified": "2013-04-18 13:14:21.067",
                "photo_file_id": "02F11D0E-BA74-4A7D-B1BE-4F7F651B2507"
            }
        },
        {
            "id": "3B972614-C56F-4A5F-A64E-E695A6F5EDE5",
            "date_created": "2013-04-22 15:23:02.020",
            "update_id": "6E9A73CC-03DA-463D-9BD9-322FB7875772",
            "member": {
                "id": "B471BFED-BCC2-49CC-A917-5F09AA73EEB3",
                "email": "mpower@example.com",
                "screen_name": "Max Power",
                "first_name": "Max",
                "last_name": "Power",
                "job_title": "Safety Inspector",
                "address": "742 Evergreen Terrace Springfield IL",
                "phone": "123456-7890",
                "mobile_phone": "987654-3210",
                "external_user_id": null,
                "skills": "Boxer, Mascot, Astronaut, Baby proofer, Truck driver, Hippie, Plow Driver, Food Critic",
                "work_history": "Conceptual Artist, Mayor, Country Western Manager, Garbage Commissioner, Mountain Climber",
                "photo_url": null,
                "date_created": "2013-04-18 11:27:48.537",
                "date_modified": null,
                "active": true
            }
        }
    ],
    "stats": {
        "total": "3",
        "page_count": 2,
        "current_page": 1
    }
}




CREATE updateHifive

Create a hifive object for an update.

Requester must have access to the environment in order to create.

Parameters

Parameters Detail
update_id
optional		 This is the ID of update where the hifive should be created for
Sample value: "11111111-1111-1111-1111-111111111111"
format
optional		 Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: Required. See Authentication for detail on authentication.

HTTP Methods: POST

Request URL Format: https://{api_domain}/api3/updateHifive

Access Permission

Requester must have access to the environment in order to create an update in it. See Authentication for detail on authentication.

Errors

  • Missing required parameter

Example Request

  • Method: POST
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/updateHifive

  • Form data:

    • update_id=DF4B804F-5929-455E-903D-D87A2B8B8FCF
    {
    "updateHifive": {
        "id": "DF4B804F-5929-455E-903D-D87A2B8B8FCF",
        "member_id": "8FA49B96-3693-4282-8919-014618D7B3B8",
        "date_created": "2013-04-22 17:04:22.763",
        "update_id": "9B061C43-4E80-498C-B41E-4482C21632F7"
    }
}




DELETE updateHifive

Delete a hifive object of an update. Requester must be an Admin. See Authentication for detail on authentication.

Parameters

Parameters Detail
update_id
optional		 This is the ID of update, parent to the hifive
Sample value: "11111111-1111-1111-1111-111111111111"
format
optional		 Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: Required. See Authentication for detail on authentication.

HTTP Methods: DELETE

Request URL Format: https://{api_domain}/api3/updateHifive

Access Permission

Requester must be an Admin. See Authentication for detail on authentication.

Errors

  • Invalid GUID received
  • Admin permission required.

Example Request

  • Method: DELETE
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/updateHifive

  • Form data:

    • update_id=DF4B804F-5929-455E-903D-D87A2B8B8FCF
    {
    "message": "success",
    "code": 200
}




FAQ

Question: LIST updateHifive only return 100 objects maximum per request. How do I retrieve more results.

Answer: LIST updateHifive response is automatically paginated. You can specify which page of the result a request should return. For example, if you requested for 100 idea objects in the initial request, pass "page_size=100&page=2" to get the next 100. page_count is returned with every LIST request so your application can figure out when it hits the end.