Jump to

• Request
• Response

Get all record parcel owners

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecParcelOwners

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a parcel owner using the specified primary key criteria.
    Finder Variables:
    • OwnerKey; integer; The unique identifier for a parcel owner.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Address1; string; The first or main address of the parcel owner.
  • Address2; string; The second address of the parcel owner, if present.
  • Address3; string; The third address of the parcel owner, if present.
  • Address4; string; The fourth address of the parcel owner, if present.
  • AgencyId; integer; The unique identifier for a public sector agency associated with a parcel owner.
  • BuildingType; string; The building type of building used in an address search. For example, Tower A or Block 3.
  • CellPhoneCountry; string; The country code for the cell phone number of parcel owner.
  • CellPhoneNumber; string; The cell phone number of the parcel owner.
  • City; string; The city in the parcel owner's address.
  • Country; string; The country in the parcel owner's address.
  • County; string; The county in the parcel owner's address.
  • CreationDate; string; The date when the parcel owner was created.
  • DocumentNumber; string; The County Recorder's office document number for the transfer of ownership.
  • EmailId; string; The email address of the parcel owner.
  • FaxCountry; string; The country code for the fax number of the parcel owner.
  • FaxNumber; string; The fax number of the parcel owner.
  • Floor; string; The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C.
  • HomePhoneCountry; string; The country code for the home telephone number of the parcel owner.
  • HomePhoneNumber; string; The home telephone number of the parcel owner.
  • LastTransferDate; string; The date of the last transfer of ownership.
  • LastTransferType; string; The type of last transfer of ownership. For example, grant deed, gift deed, or regular sale.
  • LastUpdateDate; string; The date when the parcel owner was last updated.
  • LnpRecordId; string; The unique identifier for the application record.
  • LnpRecordKey; integer; The unique identifier for the record associated with the parcel.
  • Owner; string; The name of the first or main owner.
  • OwnerId; integer; The unique identifier for the parcel owner.
  • OwnerKey; integer; The unique identifier for a record parcel owner.
  • OwnerType; string; The type of ownership. For example, business or private person.
  • ParcelId; integer; The unique identifier for the parcel.
  • ParcelKey; integer; The unique identifier for the record parcel.
  • PostalCode; string; The postal code in the parcel owner's address.
  • PostalPlus4Code; string; The extended postal code in the parcel owner's address.
  • PrimaryFlag; boolean; Indicates the primary parcel owner. If the value is Y, then the parcel owner is the primary owner. The default value is N.
  • Province; string; The province in the parcel owner's address.
  • SecondaryOwner; string; The name of the secondary owner.
  • State; string; The state in the parcel owner's address.
  • StreetDirection; string; The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center.
  • StreetName; string; The street name in the parcel owner's address used during a search.
  • StreetNumber; string; The street number in the parcel owner's address.
  • StreetType; string; The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
  • UnitNumber; string; The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
  • WorkPhoneCountry; string; The country code for the work telephone number of the parcel owner.
  • WorkPhoneNumber; string; The work telephone number of the parcel owner.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• 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.

There's no request body for this operation.

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 : publicSectorRecParcelOwners

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecParcelOwners-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Permits",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorRecParcelOwners-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecParcelOwners-item-response"
    }
}

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 : publicSectorRecParcelOwners-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first or main address of the parcel owner.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second address of the parcel owner, if present.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address of the parcel owner, if present.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address of the parcel owner, if present.
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier for a public sector agency associated with a parcel owner.
• BuildingType: string
  Title: Building

  Maximum Length: 20

  The building type of building used in an address search. For example, Tower A or Block 3.
• CellPhoneCountry: string
  Title: Cell Phone Country

  Maximum Length: 10

  The country code for the cell phone number of parcel owner.
• CellPhoneNumber: string
  Title: Cell Phone

  Maximum Length: 40

  The cell phone number of the parcel owner.
• City: string
  Title: City

  Maximum Length: 60

  The city in the parcel owner's address.
• Country: string
  Title: Country

  Maximum Length: 60

  The country in the parcel owner's address.
• County: string
  Title: County

  Maximum Length: 60

  The county in the parcel owner's address.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the parcel owner was created.
• DocumentNumber: string
  Title: Document

  Maximum Length: 50

  The County Recorder's office document number for the transfer of ownership.
• EmailId: string
  Title: Email

  Maximum Length: 50

  The email address of the parcel owner.
• FaxCountry: string
  Title: Fax Country

  Maximum Length: 10

  The country code for the fax number of the parcel owner.
• FaxNumber: string
  Title: Fax

  Maximum Length: 40

  The fax number of the parcel owner.
• Floor: string
  Title: Floor

  Maximum Length: 20

  The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C.
• HomePhoneCountry: string
  Title: Home Phone Country

  Maximum Length: 10

  The country code for the home telephone number of the parcel owner.
• HomePhoneNumber: string
  Title: Home Phone

  Maximum Length: 40

  The home telephone number of the parcel owner.
• LastTransferDate: string (date)
  Title: Last Transfer Date

  The date of the last transfer of ownership.
• LastTransferType: string
  Title: Last Transfer Type

  Maximum Length: 50

  The type of last transfer of ownership. For example, grant deed, gift deed, or regular sale.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the parcel owner was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50

  The unique identifier for the application record.
• LnpRecordKey: integer (int64)
  Title: Record

  The unique identifier for the record associated with the parcel.
• Owner: string
  Title: Owner

  Maximum Length: 150

  The name of the first or main owner.
• OwnerId: integer (int64)
  Title: Owner

  The unique identifier for the parcel owner.
• OwnerKey: integer (int64)
  Title: Owner Key

  The unique identifier for a record parcel owner.
• OwnerType: string
  Title: Ownership Type

  Maximum Length: 20

  The type of ownership. For example, business or private person.
• ParcelId: integer (int64)
  Title: Parcel

  The unique identifier for the parcel.
• ParcelKey: integer (int64)
  Title: Parcel Key

  The unique identifier for the record parcel.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code in the parcel owner's address.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 20

  The extended postal code in the parcel owner's address.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Indicates the primary parcel owner. If the value is Y, then the parcel owner is the primary owner. The default value is N.
• Province: string
  Title: Province

  Maximum Length: 60

  The province in the parcel owner's address.
• SecondaryOwner: string
  Title: Secondary Owner

  Maximum Length: 150

  The name of the secondary owner.
• State: string
  Title: State

  Maximum Length: 60

  The state in the parcel owner's address.
• StreetDirection: string
  Title: Direction

  Maximum Length: 10

  The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center.
• StreetName: string
  Title: Street

  Maximum Length: 240

  The street name in the parcel owner's address used during a search.
• StreetNumber: string
  Title: Street Number

  Maximum Length: 20

  The street number in the parcel owner's address.
• StreetType: string
  Title: Street Type

  Maximum Length: 20

  The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
• UnitNumber: string
  Title: Unit

  Maximum Length: 30

  The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
• WorkPhoneCountry: string
  Title: Work Phone Country

  Maximum Length: 10

  The country code for the work telephone number of the parcel owner.
• WorkPhoneNumber: string
  Title: Work Phone

  Maximum Length: 40

  The work telephone number of the parcel owner.

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street",
            "maxLength":"240",
            "type":"string",
            "description":"The street name in the parcel owner's address used during a search.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the parcel owner was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CellPhoneNumber":{
            "title":"Cell Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The cell phone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the first or main owner.",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the cell phone number of parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the primary parcel owner. If the value is Y, then the parcel owner is the primary owner. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for a public sector agency associated with a parcel owner.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "WorkPhoneNumber":{
            "title":"Work Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The work telephone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxCountry":{
            "title":"Fax Country",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the fax number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the parcel owner's address.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the parcel owner's address.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerType":{
            "title":"Ownership Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of ownership. For example, business or private person.",
            "nullable":true,
            "x-queryable":true
        },
        "BuildingType":{
            "title":"Building",
            "maxLength":"20",
            "type":"string",
            "description":"The building type of building used in an address search. For example, Tower A or Block 3.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner",
            "type":"integer",
            "description":"The unique identifier for the parcel owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address of the parcel owner, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneNumber":{
            "title":"Home Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The home telephone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the work telephone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxNumber":{
            "title":"Fax",
            "maxLength":"40",
            "type":"string",
            "description":"The fax number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "title":"Street Number",
            "maxLength":"20",
            "type":"string",
            "description":"The street number in the parcel owner's 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"
            }
        },
        "ParcelKey":{
            "title":"Parcel Key",
            "type":"integer",
            "description":"The unique identifier for the record parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecondaryOwner":{
            "title":"Secondary Owner",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the secondary owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the application record.",
            "nullable":false,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel",
            "type":"integer",
            "description":"The unique identifier for the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Floor":{
            "title":"Floor",
            "maxLength":"20",
            "type":"string",
            "description":"The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email",
            "maxLength":"50",
            "type":"string",
            "description":"The email address of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferType":{
            "title":"Last Transfer Type",
            "maxLength":"50",
            "type":"string",
            "description":"The type of last transfer of ownership. For example, grant deed, gift deed, or regular sale.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address of the parcel owner, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third address of the parcel owner, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first or main address of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the parcel owner's address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":"20",
            "type":"string",
            "description":"The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNumber":{
            "title":"Document",
            "maxLength":"50",
            "type":"string",
            "description":"The County Recorder's office document number for the transfer of ownership.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record",
            "type":"integer",
            "description":"The unique identifier for the record associated with the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the parcel owner's address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"20",
            "type":"string",
            "description":"The extended postal code in the parcel owner's address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the parcel owner's address.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerKey":{
            "title":"Owner Key",
            "type":"integer",
            "description":"The unique identifier for a record parcel owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StreetDirection":{
            "title":"Direction",
            "maxLength":"10",
            "type":"string",
            "description":"The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"The country in the parcel owner's address.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit",
            "maxLength":"30",
            "type":"string",
            "description":"The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the home telephone number of the parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferDate":{
            "title":"Last Transfer Date",
            "type":"string",
            "description":"The date of the last transfer of ownership.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the parcel owner was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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