Update a residency exception
patch
/fscmRestApi/resources/11.13.18.05/studentOfficialResidencies/{ResidencyId}/child/residencyExceptions/{ResidencyExceptionId}
Request
Path Parameters
-
ResidencyExceptionId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
ResidencyId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Note: string
Maximum Length:
240
The additional information entered to clarify the residency exception. -
ResidencyExceptionCode: string
Maximum Length:
30
The type of residency exception. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_EXCPT_CODE.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : studentOfficialResidencies-residencyExceptions-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Note: string
Maximum Length:
240
The additional information entered to clarify the residency exception. -
ResidencyExceptionCode: string
Maximum Length:
30
The type of residency exception. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_EXCPT_CODE. -
ResidencyExceptionId: integer
(int64)
Read Only:
true
The unique identifier for a residency exception. -
ResidencyExceptionMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The meaning of the residency exception code, such as military. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_EXCPT_CODE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- residencyExceptionTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_RESIDENCY_EXCPT_CODE%2CLookupCode%3D{ResidencyExceptionCode}
The following properties are defined on the LOV link relation:- Source Attribute: ResidencyExceptionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: