Jump to

• Request
• Response

Get a record type display group line

get

/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine/{DisplayGroupLineUniqID}

Request

Path Parameters

• DisplayGroupLineUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, DisplayGroup and RecordTypeId ---for the Record Type Display Group lines resource and used to uniquely identify an instance of Record Type Display Group lines. The client should not generate the hash key value. Instead, the client should query on the Record Type Display Group lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Record Type Display Group lines.
  
  For example: DisplayGroupLine?q=AgencyId=<value1>;DisplayGroup=<value2>;RecordTypeId=<value3>
• publicSectorDisplayGroupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and DisplayGroup ---for the Record Type Display Groups resource and used to uniquely identify an instance of Record Type Display Groups. The client should not generate the hash key value. Instead, the client should query on the Record Type Display Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Record Type Display Groups.
  
  For example: publicSectorDisplayGroups?q=AgencyId=<value1>;DisplayGroup=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

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 : publicSectorDisplayGroups-DisplayGroupLine-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of a public sector agency.
• CitizenEnabled: string
  Title: Public User Enabled

  Read Only: true

  Maximum Length: 1

  Indicates whether the record type is enabled for the public user to submit the application form. The default value is not enabled for public users.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The classification of the record. The classifications can be permit, business license, professional license, or planning and zoning.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The long description for the record type included in the display group line.
• DisplayGroup: string
  Title: Display Group ID

  Maximum Length: 30

  The display group to which the group line belongs.
• DisplayOrder: integer (int64)
  Title: Display Order

  The display number for the display group line.
• FeeScheduleId: string
  Read Only: true

  Maximum Length: 20

  Indicates the fee schedule identifier associated with the transaction.
• isRecordTypeActive: boolean
  Read Only: true

  Indicates whether the record type is active or not. The default value is active.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecordType: string
  Title: Record Type

  Read Only: true

  Maximum Length: 100

  The display name for the record type included in the display group line.
• RecordTypeCode: string
  Title: Record Type Code

  Maximum Length: 20

  The short name of the record type included in the display group line.
• RecordTypeId: string
  Title: Record Type ID

  Maximum Length: 30

  The unique identifier of the record type included in the display group line.
• RecordTypeState: string
  Read Only: true

  Maximum Length: 10

  Indicates the status of the record type. The default value is active.
• Url: string
  Title: URL

  Read Only: true

  The URL provides a link that the user can click to navigate to other pages with more information about the record type.
• ValidFromDate: string (date)
  Read Only: true

  The date when the record type is valid to use.
• ValidToDate: string (date)
  Read Only: true

  The date when the record type is no longer valid to use.

{
    "type":"object",
    "properties":{
        "ValidToDate":{
            "type":"string",
            "description":"The date when the record type is no longer valid to use.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayGroup":{
            "title":"Display Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"The display group to which the group line belongs.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The long description for the record type included in the display group line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayOrder":{
            "title":"Display Order",
            "type":"integer",
            "description":"The display number for the display group line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"20"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "RecordTypeState":{
            "maxLength":"10",
            "type":"string",
            "description":"Indicates the status of the record type. The default value is active.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenEnabled":{
            "title":"Public User Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record type is enabled for the public user to submit the application form. The default value is not enabled for public users.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "isRecordTypeActive":{
            "type":"boolean",
            "description":"Indicates whether the record type is active or not. The default value is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Url":{
            "title":"URL",
            "type":"string",
            "description":"The URL provides a link that the user can click to navigate to other pages with more information about the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "title":"Record Type Code",
            "maxLength":"20",
            "type":"string",
            "description":"The short name of the record type included in the display group line.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Record Type",
            "maxLength":"100",
            "type":"string",
            "description":"The display name for the record type included in the display group line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the record. The classifications can be permit, business license, professional license, or planning and zoning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidFromDate":{
            "type":"string",
            "description":"The date when the record type is valid to use.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Record Type ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the record type included in the display group line.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeScheduleId":{
            "maxLength":"20",
            "type":"string",
            "description":"Indicates the fee schedule identifier associated with the transaction.",
            "nullable":true,
            "readOnly":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