In This Article:

    Activity Form List

    In This Article:

       
       

      Request

      • Method: GET
      • URL: https://dev-api.salsalabs.org/api/developer/ext/v1/activities

      Parameters

      Name

      Type

      Mandatory/Optional

      Description

      types

      Comma separated list of strings

      optional

      You can specify one or many types that you want to be returned. See Activity Form Types

      criteria

      String

      optional

      A string representing full or partial activity form name,description

      sortField

      String

      optional

      sort field name. Supported values: "name", "description"

      sortOrder

      String

      optional

      sort order. Values: ASCENDING/DESCENDING

      count

      Integer

      optional

      number of results to be returned. Max = 25. Default = 10

      offset

      Integer

      optional

      records offset. Used for pagination

       

      Example: https://dev-api.salsalabs.org/api/developer/ext/v1/activities?activityTypes=FUNDRAISE,PETITION&criteria=MyForm1&sortFIeld=description&sortOrder=ASCENDING&count=20&offset=40

      Response 

      General Fields

      Name

      Type

      Description

      total

      Integer

      total forms

      offset

      Integer

      offset. number of records (pagination)

      count

      Integer

      count in current response

      results

      Array array of form meta-data

       

      Form Meta-Data

      Name

      Type

      Description

      id

      UUID

      form id

      name

      String

      form name

      description

      String

      form description

      createDate

      Date

      form creation date. ISO_8601 formatted String with a GMT timezone

      modifiedDate

      Date

      form modified date. ISO_8601 formatted String with a GMT timezone

      type

      String

      The form type, will be one of

      • SUBSCRIPTION_MANAGEMENT

      • SUBSCRIBE

      • FUNDRAISE

      • PETITION

      • TARGETED_LETTER

      • TICKETED_EVENT

      • P2P_EVENT

      status

      String

      Form status will be one of...

      • PUBLISHED

      • DRAFT

      visibility

      String

      Form visibility will be one of...

      • PRIVATE

      • PUBLIC

       

      Json Example

      {
        "id""ce5025ce-e519-4c6d-a604-54804c4dce23",
        "timestamp""2018-02-02T12:17:57.537Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
          "total"5,
          "offset"0,
          "results": [
            {
              "id""231fc7df-2e61-4a05-829b-b43492cabbe5",
              "name""Activity0",
              "description""test description",
              "createDate""2018-02-02T12:17:43.973Z",
              "modifiedDate""2018-02-02T12:17:43.973Z",
              "type""FUNDRAISE",
              "status""DRAFT",
              "visibility""PRIVATE"
            },
            {
              "id""301cd5bf-8bbb-4170-bb77-dccfa75c7c84",
              "name""Activity1",
              "description""test description",
              "createDate""2018-02-02T12:17:46.278Z",
              "modifiedDate""2018-02-02T12:17:46.278Z",
              "type""FUNDRAISE",
              "status""DRAFT",
              "visibility""PRIVATE"
            },
            {
              "id""946a01bb-4732-4501-bec4-f302c5a0e7e7",
              "name""Activity2",
              "description""test description",
              "createDate""2018-02-02T12:17:47.826Z",
              "modifiedDate""2018-02-02T12:17:47.826Z",
              "type""FUNDRAISE",
              "status""DRAFT",
              "visibility""PRIVATE"
            },
            {
              "id""5def81d2-6c4d-4809-9a6b-f30d9a22a04e",
              "name""Activity3",
              "description""test description",
              "createDate""2018-02-02T12:17:49.305Z",
              "modifiedDate""2018-02-02T12:17:49.305Z",
              "type""FUNDRAISE",
              "status""DRAFT",
              "visibility""PRIVATE"
            },
            {
              "id""fc037eb5-4a6b-4015-9013-6b2f30fb0c0b",
              "name""Activity4",
              "description""test description",
              "createDate""2018-02-02T12:17:50.564Z",
              "modifiedDate""2018-02-02T12:17:50.564Z",
              "type""FUNDRAISE",
              "status""DRAFT",
              "visibility""PRIVATE"
            }
          ],
          "count"5
        }
      }
       
      Was this article helpful?
      0 out of 0 found this helpful
      Have more questions? Submit a request

      Comments

      0 comments

      Please sign in to leave a comment.