Update an agency language
patch
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages/{publicSectorAgencyLanguagesUniqID}
Request
Path Parameters
-
publicSectorAgencyLanguagesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and LanguageCd ---for the Agency Languages resource and used to uniquely identify an instance of Agency Languages. The client should not generate the hash key value. Instead, the client should query on the Agency Languages collection resource with a filter on the primary key values in order to navigate to a specific instance of Agency Languages.
For example: publicSectorAgencyLanguages?q=AgencyId=<value1>;LanguageCd=<value2>
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
-
Description: string
Title:
Description
Maximum Length:30
The description of the language. -
PrimaryFlag: string
Title:
Primary
Maximum Length:1
Indicates that the language is the primary (base) language of the agency. -
ValidFromDate: string
(date)
Title:
From Date
The first day that the language may be used. -
ValidToDate: string
(date)
Title:
To Date
The last day that the language may be used.
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 : publicSectorAgencyLanguages-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the agency language. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the agency language was created. -
Description: string
Title:
Description
Maximum Length:30
The description of the language. -
LanguageCd: string
Title:
Language
Maximum Length:4
The unique identifier of the language that is supported by the agency. Value is mandatory and is defined by the user during a create action. -
LastUpdateDate: string
(date-time)
Read Only:
true
The last date and time that the agency language was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the agency language. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: string
Title:
Primary
Maximum Length:1
Indicates that the language is the primary (base) language of the agency. -
ValidFromDate: string
(date)
Title:
From Date
The first day that the language may be used. -
ValidToDate: string
(date)
Title:
To Date
The last day that the language may be used.
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.