| GET | /v4/links/list |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Username | query | string | No | |
| GroupId | query | uint | No | |
| LinkType | query | LinkType | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Limit | form | int | No |
| None | |
| Simple | |
| Split | |
| Interstitial | |
| Advanced | |
| Collection |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | IEnumerable<IUserLink> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | form | V4PageObject | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Limit | form | int | No | |
| TotalRecords | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Url | form | string | No | |
| BaseCode | form | string | No | |
| LinkType | form | LinkType | No | |
| TypeDefinitionPublicId | form | string | No | |
| Metadata | form | VersionedRefreshableMetadata | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| VersionCreatedDate | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CreatedDate | form | DateTime | No | |
| UpdatedDate | form | DateTime | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v4/links/list HTTP/1.1 Host: shortlinks-api.qa.platform.georiot.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"page":{"offset":0,"limit":0,"totalRecords":0},"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}