Jump to

• Request
• Response

Update a payment checkout line

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin/{CheckoutLinUniqID}

Request

Path Parameters

• CheckoutId(required): string
  The unique identifier for the checkout data. Generated using the Fusion unique ID API.
• CheckoutLinUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- CheckoutId and CheckoutLineId ---for the Checkout Lines resource and used to uniquely identify an instance of Checkout Lines. The client should not generate the hash key value. Instead, the client should query on the Checkout Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Checkout Lines.
  
  For example: CheckoutLin?q=CheckoutId=<value1>;CheckoutLineId=<value2>

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdapterId: string
  Maximum Length: 100

  The unique identifier of the payment adapter associated with the agency and payment method.
• Address1: string
  Maximum Length: 240

  The first line of the permit address.
• Address2: string
  Maximum Length: 240

  The second line of the permit address, if present.
• Address3: string
  Maximum Length: 240

  The third line of the permit address, if present.
• Address4: string
  Maximum Length: 240

  The fourth line of the permit address, if present.
• BillAgencyId: integer (int64)
  The unique identifier of the agency associated with the invoice.
• BillType: string
  Maximum Length: 15

  Determines the default invoice values for invoice form and invoice number ID.
• BusBusinessLegalName: string
  Maximum Length: 240

  The legal name of a business.
• BusBusinessName: string
  Maximum Length: 100

  The name of a business.
• BusDbaBusinessName: string
  Maximum Length: 100

  The doing business as name of a business.
• BusinessEntityId: string
  Maximum Length: 50

  The unique identifier of a business.
• BusinessLocationId: string
  Maximum Length: 50

  The unique identifier of a business location.
• BusinessLocationPartyId: integer (int64)
  The party identifier of a business location.
• BusPartyId: integer (int64)
  The party identifier of a business.
• City: string
  Maximum Length: 60

  The city in the permit address.
• Country: string
  Maximum Length: 60

  The country in the permit address.
• County: string
  Maximum Length: 60

  The county in the permit address.
• FeeReferencePuid: string
  Maximum Length: 480

  The PUID reference identifier for the fee item.
• Invoice: string
  Maximum Length: 50

  The unique billing identifier.
• InvoiceDate: string (date)
  The invoice date associated with the payment.
• InvoiceId: integer (int64)
  The invoice identifier associated with the payment.
• InvoiceLine: integer (int64)
  The invoice line associated with the payment.
• InvoiceSystemCd: string
  Maximum Length: 30

  The receivable application code where invoice is created.
• OrganizationName: string
  Maximum Length: 360

  The name of an organization.
• PaymentDate: string (date)
  The date when the checkout was initiated.
• PaymentHistoryKey: integer (int64)
  The unique payment history value generated using the Fusion unique ID API.
• PaymentMethodCode: string
  Maximum Length: 30

  The type of payment selected during checkout.
• PaymentReferenceId: string
  Maximum Length: 50

  The global unique payment identifier that comprises a 4-character prefix and random digits.
• PaymentStatus: string
  Maximum Length: 1

  The status of the payment request. Valid values are paid, cancelled, or error.
• PostalCode: string
  Maximum Length: 60

  The postal code in the permit address.
• PostalPlus4Code: string
  Maximum Length: 20

  The extended postal code in the permit address.
• Province: string
  Maximum Length: 60

  The province in the permit address.
• RecordId: string
  Maximum Length: 50

  The source application's record identifier.
• State: string
  Maximum Length: 60

  The state in the permit address.

{
    "type":"object",
    "properties":{
        "AdapterId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the payment adapter associated with the agency and payment method.",
            "nullable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the permit address.",
            "nullable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the permit address, if present.",
            "nullable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the permit address, if present.",
            "nullable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the permit address, if present.",
            "nullable":true
        },
        "BillAgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillType":{
            "maxLength":15,
            "type":"string",
            "description":"Determines the default invoice values for invoice form and invoice number ID.",
            "nullable":true
        },
        "BusBusinessLegalName":{
            "maxLength":240,
            "type":"string",
            "description":"The legal name of a business.",
            "nullable":true
        },
        "BusBusinessName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of a business.",
            "nullable":true
        },
        "BusDbaBusinessName":{
            "maxLength":100,
            "type":"string",
            "description":"The doing business as name of a business.",
            "nullable":true
        },
        "BusPartyId":{
            "type":"integer",
            "description":"The party identifier of a business.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BusinessEntityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of a business.",
            "nullable":true
        },
        "BusinessLocationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of a business location.",
            "nullable":true
        },
        "BusinessLocationPartyId":{
            "type":"integer",
            "description":"The party identifier of a business location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the permit address.",
            "nullable":true
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"The country in the permit address.",
            "nullable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the permit address.",
            "nullable":true
        },
        "FeeReferencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The PUID reference identifier for the fee item.",
            "nullable":false
        },
        "Invoice":{
            "maxLength":50,
            "type":"string",
            "description":"The unique billing identifier.",
            "nullable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The invoice date associated with the payment.",
            "format":"date",
            "nullable":true
        },
        "InvoiceId":{
            "type":"integer",
            "description":"The invoice identifier associated with the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InvoiceLine":{
            "type":"integer",
            "description":"The invoice line associated with the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InvoiceSystemCd":{
            "maxLength":30,
            "type":"string",
            "description":"The receivable application code where invoice  is created.",
            "nullable":true
        },
        "OrganizationName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of an organization.",
            "nullable":true
        },
        "PaymentDate":{
            "type":"string",
            "description":"The date when the checkout was initiated.",
            "format":"date",
            "nullable":true
        },
        "PaymentHistoryKey":{
            "type":"integer",
            "description":"The unique payment history value generated using the Fusion unique ID API.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The type of payment selected during checkout.",
            "nullable":true
        },
        "PaymentReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The global unique payment identifier that comprises a 4-character prefix and random digits.",
            "nullable":true
        },
        "PaymentStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The status of the payment request. Valid values are paid, cancelled, or error.",
            "nullable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the permit address.",
            "nullable":true
        },
        "PostalPlus4Code":{
            "maxLength":20,
            "type":"string",
            "description":"The extended postal code in the permit address.",
            "nullable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the permit address.",
            "nullable":true
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The source application's record identifier.",
            "nullable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the permit address.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorCheckouts-CheckoutLin-item-response

Type: object

Show Source

• AdapterId: string
  Maximum Length: 100

  The unique identifier of the payment adapter associated with the agency and payment method.
• Address1: string
  Maximum Length: 240

  The first line of the permit address.
• Address2: string
  Maximum Length: 240

  The second line of the permit address, if present.
• Address3: string
  Maximum Length: 240

  The third line of the permit address, if present.
• Address4: string
  Maximum Length: 240

  The fourth line of the permit address, if present.
• AgencyId: integer (int32)
  The unique identifier of the agency associated with the row.
• ApplicationReferenceId: string
  Maximum Length: 50

  The key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart.
• ApplicationReferenceIdPlus: string
  Maximum Length: 50

  Additional key identifier passed by the consuming application.
• BillAgencyId: integer (int64)
  The unique identifier of the agency associated with the invoice.
• BillType: string
  Maximum Length: 15

  Determines the default invoice values for invoice form and invoice number ID.
• BusBusinessLegalName: string
  Maximum Length: 240

  The legal name of a business.
• BusBusinessName: string
  Maximum Length: 100

  The name of a business.
• BusDbaBusinessName: string
  Maximum Length: 100

  The doing business as name of a business.
• BusinessEntityId: string
  Maximum Length: 50

  The unique identifier of a business.
• BusinessLocationId: string
  Maximum Length: 50

  The unique identifier of a business location.
• BusinessLocationPartyId: integer (int64)
  The party identifier of a business location.
• BusPartyId: integer (int64)
  The party identifier of a business.
• CaseId: string
  Maximum Length: 50

  The case identifier for a code enforcement fee.
• CheckoutId: string
  Maximum Length: 50

  The unique identifier for the checkout data. Generated using the Fusion unique ID API.
• CheckoutLineId: integer (int64)
  The unique sequence number for the checkout row generated using the Fusion unique ID API.
• City: string
  Maximum Length: 60

  The city in the permit address.
• Classification: string
  Maximum Length: 3

  The source application that generated the fee.
• Country: string
  Maximum Length: 60

  The country in the permit address.
• County: string
  Maximum Length: 60

  The county in the permit address.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the row was created.
• CurrencyCode: string
  Maximum Length: 3

  The currency code in relation to the item unit price and tax amount.
• Department: string
  Maximum Length: 30

  A division within the agency devoted to a specific function.
• FeeItemId: string
  Maximum Length: 30

  The unique identifier for the fee item.
• FeeReferenceId: string
  Maximum Length: 50

  The reference identifier for the fee item.
• FeeReferencePuid: string
  Maximum Length: 480

  The PUID reference identifier for the fee item.
• Invoice: string
  Maximum Length: 50

  The unique billing identifier.
• InvoiceDate: string (date)
  The invoice date associated with the payment.
• InvoiceId: integer (int64)
  The invoice identifier associated with the payment.
• InvoiceLine: integer (int64)
  The invoice line associated with the payment.
• InvoiceSystemCd: string
  Maximum Length: 30

  The receivable application code where invoice is created.
• ItemDescription: string
  Maximum Length: 50

  Relevant details related to the line item.
• ItemId: string
  Maximum Length: 30

  The unique identifier of the item to be paid.
• ItemQuantity: integer
  Quantity of line items. This value cannot be negative.
• ItemTaxAmount: number
  Default Value: 0

  The tax amount to apply to the line item.
• ItemUnitPrice: number
  Price per unit of the line item. This value multiplied by the item quantity value equals the total line item amount.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationName: string
  Maximum Length: 360

  The name of an organization.
• PaymentDate: string (date)
  The date when the checkout was initiated.
• PaymentHistoryKey: integer (int64)
  The unique payment history value generated using the Fusion unique ID API.
• PaymentMethodCode: string
  Maximum Length: 30

  The type of payment selected during checkout.
• PaymentReferenceId: string
  Maximum Length: 50

  The global unique payment identifier that comprises a 4-character prefix and random digits.
• PaymentStatus: string
  Maximum Length: 1

  The status of the payment request. Valid values are paid, cancelled, or error.
• PostalCode: string
  Maximum Length: 60

  The postal code in the permit address.
• PostalPlus4Code: string
  Maximum Length: 20

  The extended postal code in the permit address.
• Province: string
  Maximum Length: 60

  The province in the permit address.
• RecordId: string
  Maximum Length: 50

  The source application's record identifier.
• RecordTypeId: string
  Maximum Length: 30

  The source application's record identifier.
• State: string
  Maximum Length: 60

  The state in the permit address.

{
    "type":"object",
    "properties":{
        "AdapterId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the payment adapter associated with the agency and payment method.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the permit address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the permit address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the permit address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the permit address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ApplicationReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplicationReferenceIdPlus":{
            "maxLength":50,
            "type":"string",
            "description":"Additional key identifier passed by the consuming application.",
            "nullable":true,
            "x-queryable":true
        },
        "BillAgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillType":{
            "maxLength":15,
            "type":"string",
            "description":"Determines the default invoice values for invoice form and invoice number ID.",
            "nullable":true,
            "x-queryable":true
        },
        "BusBusinessLegalName":{
            "maxLength":240,
            "type":"string",
            "description":"The legal name of a business.",
            "nullable":true,
            "x-queryable":true
        },
        "BusBusinessName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of a business.",
            "nullable":true,
            "x-queryable":true
        },
        "BusDbaBusinessName":{
            "maxLength":100,
            "type":"string",
            "description":"The doing business as name of a business.",
            "nullable":true,
            "x-queryable":true
        },
        "BusPartyId":{
            "type":"integer",
            "description":"The party identifier of a business.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of a business.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessLocationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of a business location.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessLocationPartyId":{
            "type":"integer",
            "description":"The party identifier of a business location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The case identifier for a code enforcement fee.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the checkout data. Generated using the Fusion unique ID API.",
            "nullable":false,
            "x-queryable":true
        },
        "CheckoutLineId":{
            "type":"integer",
            "description":"The unique sequence number for the checkout row generated using the Fusion unique ID API.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the permit address.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The source application that generated the fee.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"The country in the permit address.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the permit address.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code in relation to the item unit price and tax amount.",
            "nullable":false,
            "x-queryable":true
        },
        "Department":{
            "maxLength":30,
            "type":"string",
            "description":"A division within the agency devoted to a specific function.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeItemId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the fee item.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The reference identifier for the fee item.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeReferencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The PUID reference identifier for the fee item.",
            "nullable":false,
            "x-queryable":true
        },
        "Invoice":{
            "maxLength":50,
            "type":"string",
            "description":"The unique billing identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The invoice date associated with the payment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceId":{
            "type":"integer",
            "description":"The invoice identifier associated with the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceLine":{
            "type":"integer",
            "description":"The invoice line associated with the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceSystemCd":{
            "maxLength":30,
            "type":"string",
            "description":"The receivable application code where invoice  is created.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":50,
            "type":"string",
            "description":"Relevant details related to the line item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the item to be paid.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemQuantity":{
            "type":"integer",
            "description":"Quantity of line items. This value cannot be negative.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemTaxAmount":{
            "type":"number",
            "description":"The tax amount to apply to the line item.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "ItemUnitPrice":{
            "type":"number",
            "description":"Price per unit of the line item. This value multiplied by the item quantity value equals the total line item amount.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of an organization.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentDate":{
            "type":"string",
            "description":"The date when the checkout was initiated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentHistoryKey":{
            "type":"integer",
            "description":"The unique payment history value generated using the Fusion unique ID API.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The type of payment selected during checkout.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The global unique payment identifier that comprises a 4-character prefix and random digits.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The status of the payment request. Valid values are paid, cancelled, or error.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the permit address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":20,
            "type":"string",
            "description":"The extended postal code in the permit address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the permit address.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The source application's record identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The source application's record identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the permit address.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top