Update a credential
patch
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/Credential/{publicSectorBlRecords_Credential_Id}
Request
Path Parameters
-
LnpRecordKey(required): integer(int64)
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning and is determined by the classification.
-
publicSectorBlRecords_Credential_Id(required): string
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
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
DisplaySequence: integer
(int64)
The display sequence of the credential.
-
LnpRecordId: string
Maximum Length:
50
Default Value:NEXT
The unique identifier for a record. The record is for a business license and is determined by the classification. -
LnpRecordKey: integer
(int64)
The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
-
OraAmount: number
The amount associated with the credential.
-
OraBusinessName: string
Maximum Length:
200
The associated business name. -
OraCertificateNumber: string
Maximum Length:
200
The certificate or license number associated with the credential. -
OraCurrency: string
Maximum Length:
3
The currency associated with an amount. -
OraDescription: string
Maximum Length:
250
The description associated with the credential. -
OraExempt: string
Maximum Length:
1
Default Value:N
Indicates whether the credential is exempted. -
OraExemptReason: string
Maximum Length:
200
The exemption reason for the credential. -
OraExpirationDate: string
(date)
The expiration date for a certificate or license number.
-
OraQualifierName: string
Maximum Length:
200
The name of the qualifying individual. -
OraStartDate: string
(date)
The start date of the certificate or license number.
-
RecordNumber: string
Maximum Length:
64
The public unique identifier for a business license record, which is an alternate key used by the CRM Import process. -
SubjectId: string
Maximum Length:
30
The attribute used to identify where the data should be displayed.
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.
Root Schema : publicSectorBlRecords-Credential-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
CredentialCode: string
Maximum Length:
30
The unique identifier for a specific credential code. -
DisplaySequence: integer
(int64)
The display sequence of the credential.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpCredentialKey: integer
(int64)
The unique identifier for a specific credential record.
-
LnpCredentialPuid: string
Maximum Length:
480
The public unique identifier for the license, which is an alternate key used by the CRM Import process. -
LnpRecordId: string
Maximum Length:
50
Default Value:NEXT
The unique identifier for a record. The record is for a business license and is determined by the classification. -
LnpRecordKey: integer
(int64)
The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
-
OraAmount: number
The amount associated with the credential.
-
OraBusinessName: string
Maximum Length:
200
The associated business name. -
OraCertificateNumber: string
Maximum Length:
200
The certificate or license number associated with the credential. -
OraCurrency: string
Maximum Length:
3
The currency associated with an amount. -
OraDescription: string
Maximum Length:
250
The description associated with the credential. -
OraExempt: string
Maximum Length:
1
Default Value:N
Indicates whether the credential is exempted. -
OraExemptReason: string
Maximum Length:
200
The exemption reason for the credential. -
OraExpirationDate: string
(date)
The expiration date for a certificate or license number.
-
OraQualifierName: string
Maximum Length:
200
The name of the qualifying individual. -
OraStartDate: string
(date)
The start date of the certificate or license number.
-
RecordNumber: string
Maximum Length:
64
The public unique identifier for a business license record, which is an alternate key used by the CRM Import process. -
SubjectId: string
Maximum Length:
30
The attribute used to identify where the data should be displayed.
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.