Jump to

• Request
• Response

Get all business license credentials

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentials

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 credentials that matches the specified filter values.
    Finder Variables:
    • LnpCredentialKey; integer; Finds credentials that matches the specified business license credential.
    • LnpRecordId; string; Finds credentials that matches the specified business license identifier.
    • LnpRecordKey; integer; Finds credentials that matches the specified business license key.
• 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:
  

  • AgencyId; integer; The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
  • CredentialCode; string; Indicates the type of credential.
  • ExemptReasonMeaning; string; Meaning of the credential exemption reason.
  • LnpCredentialKey; integer; Auto generated number used uniquely to identify the credential on the transaction.
  • LnpRecordId; string; The unique identifier for the record.
  • LnpRecordKey; integer; The identifier for the business license record.
  • OraAmount; number; Amount associated with the credential.
  • OraBusinessName; string; Identifies the associated business name.
  • OraCertificateNumber; string; Certificate or license number associated with the credential.
  • OraCurrency; string; Currency associated with the amount.
  • OraDescription; string; Description associated with the credential.
  • OraExempt; string; Indicates whether the business is exempted from the credential.
  • OraExemptReason; string; Identifies the reason behind the credential exemption.
  • OraExpirationDate; string; Expiration date for the certificate or license number.
  • OraQualifierName; string; Identifies the name of the qualifying individual.
  • OraStartDate; string; Start date for the certificate or license number.
  • ShortDescr; string; Short description of the credential.
• 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: string
  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: string
  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 : publicSectorRecordCredentials

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/publicSectorRecordCredentials-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"CommonSetup",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorRecordCredentials-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordCredentials-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 : publicSectorRecordCredentials-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
• CredentialCode: string
  Title: Credential Code

  Read Only: true

  Maximum Length: 30

  Indicates the type of credential.
• ExemptReasonMeaning: string
  Title: Credential Exemption Reason

  Read Only: true

  Maximum Length: 80

  Meaning of the credential exemption reason.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpCredentialKey: integer
  Read Only: true

  Auto generated number used uniquely to identify the credential on the transaction.
• LnpRecordId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier for the record.
• LnpRecordKey: integer (int64)
  Read Only: true

  The identifier for the business license record.
• OraAmount: number
  Title: Credential Amount

  Read Only: true

  Amount associated with the credential.
• OraBusinessName: string
  Title: Credential Business Name

  Read Only: true

  Maximum Length: 200

  Identifies the associated business name.
• OraCertificateNumber: string
  Title: Credential Certificate Number

  Read Only: true

  Maximum Length: 200

  Certificate or license number associated with the credential.
• OraCurrency: string
  Title: Credential Currency

  Read Only: true

  Maximum Length: 3

  Currency associated with the amount.
• OraDescription: string
  Title: Credential Details

  Read Only: true

  Maximum Length: 250

  Description associated with the credential.
• OraExempt: string
  Title: Credential Exemption

  Read Only: true

  Maximum Length: 1

  Indicates whether the business is exempted from the credential.
• OraExemptReason: string
  Read Only: true

  Maximum Length: 200

  Identifies the reason behind the credential exemption.
• OraExpirationDate: string (date)
  Title: Credential Expiration Date

  Read Only: true

  Expiration date for the certificate or license number.
• OraQualifierName: string
  Title: Credential Qualifier Name

  Read Only: true

  Maximum Length: 200

  Identifies the name of the qualifying individual.
• OraStartDate: string (date)
  Title: Credential Start Date

  Read Only: true

  Start date for the certificate or license number.
• ShortDescr: string
  Title: Credential Name

  Read Only: true

  Maximum Length: 100

  Short description of the credential.

{
    "type":"object",
    "properties":{
        "ShortDescr":{
            "title":"Credential Name",
            "maxLength":100,
            "type":"string",
            "description":"Short description of the credential.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LnpCredentialKey":{
            "type":"integer",
            "description":"Auto generated number used uniquely to identify the credential on the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CredentialCode":{
            "title":"Credential Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credential.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":8,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "OraDescription":{
            "title":"Credential Details",
            "maxLength":250,
            "type":"string",
            "description":"Description associated with the credential.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraBusinessName":{
            "title":"Credential Business Name",
            "maxLength":200,
            "type":"string",
            "description":"Identifies the associated business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraAmount":{
            "title":"Credential Amount",
            "type":"number",
            "description":"Amount associated with the credential.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExemptReasonMeaning":{
            "title":"Credential Exemption Reason",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the credential exemption reason.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The identifier for the business license record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"Value"
            },
            "x-queryable":true
        },
        "OraStartDate":{
            "title":"Credential Start Date",
            "type":"string",
            "description":"Start date for the certificate or license number.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraQualifierName":{
            "title":"Credential Qualifier Name",
            "maxLength":200,
            "type":"string",
            "description":"Identifies the name of the qualifying individual.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraCertificateNumber":{
            "title":"Credential Certificate Number",
            "maxLength":200,
            "type":"string",
            "description":"Certificate or license number associated with the credential.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraExemptReason":{
            "maxLength":200,
            "type":"string",
            "description":"Identifies the reason behind the credential exemption.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "OraExempt":{
            "title":"Credential Exemption",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business is exempted from the credential.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraCurrency":{
            "title":"Credential Currency",
            "maxLength":3,
            "type":"string",
            "description":"Currency associated with the amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraExpirationDate":{
            "title":"Credential Expiration Date",
            "type":"string",
            "description":"Expiration date for the certificate or license number.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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