Jump to

• Request
• Response

Create a set of credentials

post

/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/Credential

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.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a record. The record is for a business license and is determined by the classification.",
            "nullable":false,
            "default":"NEXT"
        },
        "LnpCredentialKey":{
            "type":"integer",
            "description":"The unique identifier for a specific credential record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CredentialCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a specific credential code.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "LnpCredentialPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for the license, which is an alternate key used by the CRM Import process.",
            "nullable":false
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"The display sequence of the credential.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OraDescription":{
            "maxLength":250,
            "type":"string",
            "description":"The description associated with the credential.",
            "nullable":true
        },
        "OraBusinessName":{
            "maxLength":200,
            "type":"string",
            "description":"The associated business name.",
            "nullable":true
        },
        "OraAmount":{
            "type":"number",
            "description":"The amount associated with the credential.",
            "nullable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OraStartDate":{
            "type":"string",
            "description":"The start date of the certificate or license number.",
            "format":"date",
            "nullable":true
        },
        "OraQualifierName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the qualifying individual.",
            "nullable":true
        },
        "OraCertificateNumber":{
            "maxLength":200,
            "type":"string",
            "description":"The certificate or license number associated with the credential.",
            "nullable":true
        },
        "OraExemptReason":{
            "maxLength":200,
            "type":"string",
            "description":"The exemption reason for the credential.",
            "nullable":true
        },
        "OraExempt":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the credential is exempted.",
            "nullable":true,
            "default":"N"
        },
        "OraCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"The currency associated with an amount.",
            "nullable":true
        },
        "OraExpirationDate":{
            "type":"string",
            "description":"The expiration date for a certificate or license number.",
            "format":"date",
            "nullable":true
        },
        "SubjectId":{
            "maxLength":30,
            "type":"string",
            "description":"The attribute used to identify where the data should be displayed.",
            "nullable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier for a business license record, which is an alternate key used by the CRM Import process.",
            "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(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.

Body ()

Root Schema : publicSectorBlRecords-Credential-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a record. The record is for a business license and is determined by the classification.",
            "nullable":false,
            "default":"NEXT",
            "x-queryable":true
        },
        "LnpCredentialKey":{
            "type":"integer",
            "description":"The unique identifier for a specific credential record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CredentialCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a specific credential code.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "LnpCredentialPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for the license, which is an alternate key used by the CRM Import process.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"The display sequence of the credential.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OraDescription":{
            "maxLength":250,
            "type":"string",
            "description":"The description associated with the credential.",
            "nullable":true,
            "x-queryable":true
        },
        "OraBusinessName":{
            "maxLength":200,
            "type":"string",
            "description":"The associated business name.",
            "nullable":true,
            "x-queryable":true
        },
        "OraAmount":{
            "type":"number",
            "description":"The amount associated with the credential.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OraStartDate":{
            "type":"string",
            "description":"The start date of the certificate or license number.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OraQualifierName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the qualifying individual.",
            "nullable":true,
            "x-queryable":true
        },
        "OraCertificateNumber":{
            "maxLength":200,
            "type":"string",
            "description":"The certificate or license number associated with the credential.",
            "nullable":true,
            "x-queryable":true
        },
        "OraExemptReason":{
            "maxLength":200,
            "type":"string",
            "description":"The exemption reason for the credential.",
            "nullable":true,
            "x-queryable":true
        },
        "OraExempt":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the credential is exempted.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "OraCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"The currency associated with an amount.",
            "nullable":true,
            "x-queryable":true
        },
        "OraExpirationDate":{
            "type":"string",
            "description":"The expiration date for a certificate or license number.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubjectId":{
            "maxLength":30,
            "type":"string",
            "description":"The attribute used to identify where the data should be displayed.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier for a business license record, which is an alternate key used by the CRM Import process.",
            "nullable":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