Get Supporting Document Templates

Description

Lists all supporting document templates.

Request

HTTP Method: GET

URI Path: /v3/supporting_document_templates

URI Query Parameters:

Name

Type

Is Required?

Description

filter[<filter_name>]

integer, string, DateTime

Optional

Filtering

includes

string

Optional

Inclusion

sort

string

Optional

Inclusion

Filters:

Filter Name

Type

Allow Blank

Allow Array

Filters by:

permanent

boolean

No

No

The permanent field.

name

string

No

No

The name field exact match.

name_contains

string

No

No

The name field contains.

Fielding:

Value

Returns:

name

The name attribute.

permanent

The permanent attribute.

url

The url attribute.

Examples

http

GET /v3/supporting_document_templates HTTP/1.1
        Host: api.didww.com
        Content-Type: application/vnd.api+json
        Accept: application/vnd.api+json
        Api-Key: [API token]

curl

curl -i https://nohost/v3/supporting_document_templates

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

        {
            "data": [
                {
                    "id": "206ccec2-1166-461f-9f58-3a56823db548",
                    "type": "supporting_document_templates",
                    "attributes": {
                        "name": "Generic LOI",
                        "permanent": false,
                        "url": "https://sandbox-api.didww.com/storage/public/w7f2irbo819la7vd7up7u67pkmkn"
                    }
                },
                {
                    "id": "fd38c86d-b69b-4ca8-b73c-286a3b93d107",
                    "type": "supporting_document_templates",
                    "attributes": {
                        "name": "Belgium Registration Form",
                        "permanent": true,
                        "url": "https://sandbox-api.didww.com/storage/public/e8lziulj68xetfa5ed6na3g7q7ra"
                    }
                },
                {
                    "id": "4199435f-646e-4e9d-a143-8f3b972b10c5",
                    "type": "supporting_document_templates",
                    "attributes": {
                        "name": "Germany Special Registration Form",
                        "permanent": true,
                        "url": "https://sandbox-api.didww.com/storage/public/4rghqnqtba0fa7mbdgig086xej1e"
                    }
                },
                {
                    "id": "94be4d74-c968-4d81-91c5-2d11b4e45328",
                    "type": "supporting_document_templates",
                    "attributes": {
                        "name": "LOI Example",
                        "permanent": false,
                        "url": "https://sandbox-api.didww.com/storage/public/xptvgb8derrz0ru95wr9oi68g9tg"
                    }
                },
                {
                    "id": "eb810289-8620-44e1-982d-13e6cee70404",
                    "type": "supporting_document_templates",
                    "attributes": {
                        "name": "TestPermanDoc",
                        "permanent": true,
                        "url": "https://sandbox-api.didww.com/storage/public/owwqi77007ks4qx198b7su3eukg6"
                    }
                },
                {
                    "id": "f65149c1-b551-4444-97d7-22939445c42a",
                    "type": "supporting_document_templates",
                    "attributes": {
                        "name": "TestDoc4",
                        "permanent": true,
                        "url": "https://sandbox-api.didww.com/storage/public/txm3ftmuhyhypm6553b2874iuljg"
                    }
                },
                {
                    "id": "8aacfda9-f78a-4d17-8d05-82e344bf822d",
                    "type": "supporting_document_templates",
                    "attributes": {
                        "name": "test",
                        "permanent": false,
                        "url": "https://sandbox-api.didww.com/storage/public/of8dctya2w8fqf3hxu71a3hcmsa4"
                    }
                },
                {
                    "id": "83f83c27-af8d-43f4-a9ca-a84c363e3e25",
                    "type": "supporting_document_templates",
                    "attributes": {
                        "name": "Brazilian DIDWW LOA",
                        "permanent": false,
                        "url": "https://sandbox-api.didww.com/storage/public/gvbw9l9jcegb5re30afhpu4eisvu"
                    }
                },
                {
                    "id": "6da59922-6c98-4cfa-bd0e-ec15f71eb1ff",
                    "type": "supporting_document_templates",
                    "attributes": {
                        "name": "Test34",
                        "permanent": false,
                        "url": "https://sandbox-api.didww.com/storage/public/o9rz29nhi4eoip5obmtuv7w23cvf"
                    }
                }
            ],
            "meta": {
                "total_records": 30,
                "api_version": "2021-04-19"
            },
            "links": {
                "first": "https://sandbox-api.didww.com/v3/supporting_document_templates?page%5Bnumber%5D=1&page%5Bsize%5D=50",
                "last": "https://sandbox-api.didww.com/v3/supporting_document_templates?page%5Bnumber%5D=1&page%5Bsize%5D=50"
            }
        }

http

GET /v3/supporting_document_templates?filter%5Bname_contains%5D=Germany HTTP/1.1
        Host: api.didww.com
        Content-Type: application/vnd.api+json
        Accept: application/vnd.api+json
        Api-Key: [API token]

curl

curl -i 'https://nohost/v3/supporting_document_templates?filter%5Bname_contains%5D=Germany'

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

    {
       "data": [   {
          "id": "a6f8fa4f-302b-447a-880f-f68407c67e78",
          "type": "supporting_document_templates",
          "attributes":       {
             "name": "Germany Registration Form",
             "permanent": true,
             "url": "https://api.didww.com/storage/public/kb5ovqxc43xhompzcrhh6e3fz7mo"
          }
       }],
       "meta":    {
          "total_records": 1,
          "api_version": "2021-04-19"
       },
       "links":    {
          "first": "https://api.didww.com/v3/supporting_document_templates?filter%5Bname_contains%5D=Germany&page%5Bnumber%5D=1&page%5Bsize%5D=50",
          "last": "https://api.didww.com/v3/supporting_document_templates?filter%5Bname_contains%5D=Germany&page%5Bnumber%5D=1&page%5Bsize%5D=50"
       }
    }