1
0
Files
PayPal-PHP-Server-SDK/doc/models/link-description.md
2024-09-04 15:55:32 +00:00

1.2 KiB

Link Description

The request-related HATEOAS link information.

Structure

LinkDescription

Fields

Name Type Tags Description Getter Setter
href string Required The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call. getHref(): string setHref(string href): void
rel string Required The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations. getRel(): string setRel(string rel): void
method ?string(LinkHTTPMethod) Optional The HTTP method required to make the related call. getMethod(): ?string setMethod(?string method): void

Example (as JSON)

{
  "href": "href2",
  "rel": "rel6",
  "method": "PUT"
}