| GET | /v4/links | ||
|---|---|---|---|
| GET | /v4/links/{Id} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | string | No | |
| Username | query | string | No | |
| GroupId | query | uint | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | IUserLink | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | 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 |
| None | |
| Simple | |
| Split | |
| Interstitial | |
| Advanced | |
| Collection |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v4/links HTTP/1.1 Host: shortlinks-api.qa.platform.georiot.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}