Jump to

• Request
• Response

Get all user setups is not supported

get

/fscmRestApi/resources/11.13.18.05/publicSectorUserSetups

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 the user setup configuration that matches the primary key criteria specified.
    Finder Variables:
    • UserSetupId; string; The unique identifier of the user setup configuration.
• 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:
  

  • AllowAttachments; string; Indicates whether users can attach documents in account management. If the value is Y, users can attach documents. The default value is N.
  • AllowDelegation; string; When this option is enabled, registered users can delegate transactions to other users. Delegation can be for all transactions for a profile or for individual transactions. The default value is N.
  • AllowDeleteAttachments; string; Indicates whether registered public users can delete documents in account management.
  • AllowIvrAccess; string; Indicates whether a registered user can enter a code into an interactive voice response system to access permit records and maintain inspection schedules The default value is N.
  • AllowNumDelegates; integer; Identifies the number of delegates allowed per profile. The limit is 999.
  • AllowTextCommunication; string; Indicates whether a registered user can choose to receive communications as text messages. The default value is N.
  • AllowUpdAllTrans; string; Indicates whether a registered user can delegate the ability to manage all transactions for an account profile. The default value is N.
  • AllowUpdSpecificTrans; string; Indicates whether a registered user can delegate the ability to manage individual transactions. The default value is N.
  • AllowViewAllTrans; string; Indicates whether a registered user can delegate view-only access for all transactions for an account profile. The default value is N.
  • AllowViewProfAttach; string; Indicates whether a user with delegated access to all transactions in a profile can also view attachments for the profile. The default value is N.
  • AllowViewProfContacts; string; Indicates whether a user with delegated access to all transactions in a profile can also view contacts for the profile. The default value is N.
  • AllowViewProfLicense; string; Indicates whether a user with delegated access to all transactions in a profile can also view licenses for the profile. The default value is N.
  • AllowViewSpecificTrans; string; Indicates whether a registered user can delegate view-only access for individual transactions. The default value is N.
  • DeletedFlag; boolean; Indicates whether the record is logically deleted. If the value is Y, the record has been logically deleted. The default value is N.
  • DocGroupId; string; Indicates the attachment document group.
  • InvitationExpiryOpt; string; Identifies the unit of time for the delegation invitation expiration period. The options are Days, Weeks, or Months.
  • InviteExpiryNum; integer; Identifies the number of days, weeks or months for the delegation invitation expiration period. This attribute is just for the number. Use the Invitation Expiry Option attribute to define the type of time period.
  • Meaning; string; Identifies the meaning that is associated with the Invitation Expiry Option lookup value.
  • RequestDelegateProjMgr; string; Indicates whether registered users who are the primary contact for a project can request delegation. The default value is N.
  • SeedDataLock; integer; Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that customers can modify.
  • SensitiveFlagAll; string; Indicates whether an agency can hide contact information for all applicants from public view. The default value is N.
  • SensitiveFlagOn; string; Indicates whether registered users can hide contact information from public view. If the value is Y, data for users who choose to hide contact information may require special handling. The default value is N.
  • SuppressEmail; string; Indicates whether a profile or transaction owner can suppress emails for actions performed by a delegate. The default value is N.
  • TermsOfUseOn; string; Indicates whether users need to accept terms of use when registering. If the value is Y, the user needs to accept the terms. The default value is N.
  • UserCategory; string; Category to be assigned to a user for system access notifications and for URL redirection after the user creates an initial password.
  • UserSetupId; string; Identifies the row in the public user setup table. The only valid value is PSC.
  • UserTermsOfUseId; string; Identifier for the terms of use, if any, that the user needs to accept during registration.
• 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:
  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 : publicSectorUserSetups

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorUserSetups-item-response

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

Type: object

Show Source

• AllowAttachments: string
  Maximum Length: 1

  Indicates whether users can attach documents in account management. If the value is Y, users can attach documents. The default value is N.
• AllowDelegation: string
  Maximum Length: 1

  When this option is enabled, registered users can delegate transactions to other users. Delegation can be for all transactions for a profile or for individual transactions. The default value is N.
• AllowDeleteAttachments: string
  Maximum Length: 1

  Indicates whether registered public users can delete documents in account management.
• AllowIvrAccess: string
  Maximum Length: 1

  Default Value: N

  Indicates whether a registered user can enter a code into an interactive voice response system to access permit records and maintain inspection schedules The default value is N.
• AllowNumDelegates: integer (int32)
  Identifies the number of delegates allowed per profile. The limit is 999.
• AllowTextCommunication: string
  Maximum Length: 1

  Indicates whether a registered user can choose to receive communications as text messages. The default value is N.
• AllowUpdAllTrans: string
  Maximum Length: 1

  Indicates whether a registered user can delegate the ability to manage all transactions for an account profile. The default value is N.
• AllowUpdSpecificTrans: string
  Maximum Length: 1

  Indicates whether a registered user can delegate the ability to manage individual transactions. The default value is N.
• AllowViewAllTrans: string
  Maximum Length: 1

  Indicates whether a registered user can delegate view-only access for all transactions for an account profile. The default value is N.
• AllowViewProfAttach: string
  Maximum Length: 1

  Indicates whether a user with delegated access to all transactions in a profile can also view attachments for the profile. The default value is N.
• AllowViewProfContacts: string
  Maximum Length: 1

  Indicates whether a user with delegated access to all transactions in a profile can also view contacts for the profile. The default value is N.
• AllowViewProfLicense: string
  Maximum Length: 1

  Indicates whether a user with delegated access to all transactions in a profile can also view licenses for the profile. The default value is N.
• AllowViewSpecificTrans: string
  Maximum Length: 1

  Indicates whether a registered user can delegate view-only access for individual transactions. The default value is N.
• DeletedFlag: boolean
  Maximum Length: 1

  Indicates whether the record is logically deleted. If the value is Y, the record has been logically deleted. The default value is N.
• DocGroupId: string
  Title: Document Group ID

  Maximum Length: 30

  Indicates the attachment document group.
• InvitationExpiryOpt: string
  Maximum Length: 30

  Identifies the unit of time for the delegation invitation expiration period. The options are Days, Weeks, or Months.
• InviteExpiryNum: integer (int32)
  Identifies the number of days, weeks or months for the delegation invitation expiration period. This attribute is just for the number. Use the Invitation Expiry Option attribute to define the type of time period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Meaning: string
  Read Only: true

  Maximum Length: 80

  Identifies the meaning that is associated with the Invitation Expiry Option lookup value.
• RequestDelegateProjMgr: string
  Maximum Length: 1

  Indicates whether registered users who are the primary contact for a project can request delegation. The default value is N.
• SeedDataLock: integer (int32)
  Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that customers can modify.
• SensitiveFlagAll: string
  Maximum Length: 1

  Default Value: N

  Indicates whether an agency can hide contact information for all applicants from public view. The default value is N.
• SensitiveFlagOn: string
  Maximum Length: 1

  Indicates whether registered users can hide contact information from public view. If the value is Y, data for users who choose to hide contact information may require special handling. The default value is N.
• SuppressEmail: string
  Maximum Length: 1

  Indicates whether a profile or transaction owner can suppress emails for actions performed by a delegate. The default value is N.
• TermsOfUseOn: string
  Maximum Length: 1

  Indicates whether users need to accept terms of use when registering. If the value is Y, the user needs to accept the terms. The default value is N.
• UserCategory: string
  Maximum Length: 240

  Category to be assigned to a user for system access notifications and for URL redirection after the user creates an initial password.
• UserSetupId: string
  Maximum Length: 3

  Identifies the row in the public user setup table. The only valid value is PSC.
• UserTermsOfUseId: string
  Title: Terms of Use ID

  Maximum Length: 15

  Identifier for the terms of use, if any, that the user needs to accept during registration.

{
    "type":"object",
    "properties":{
        "UserCategory":{
            "maxLength":"240",
            "type":"string",
            "description":"Category to be assigned to a user for system access notifications and for URL redirection after the user creates an initial password.",
            "nullable":false,
            "x-queryable":true
        },
        "UserSetupId":{
            "maxLength":"3",
            "type":"string",
            "description":"Identifies the row in the public user setup table. The only valid value is PSC.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowViewProfContacts":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a user with delegated access to all transactions in a profile can also view contacts for the profile. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "TermsOfUseOn":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether users need to accept terms of use when registering. If the value is Y, the user needs to accept the terms. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "SuppressEmail":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a profile or transaction owner can suppress emails for actions performed by a delegate. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowViewAllTrans":{
            "maxLength":"1",
            "type":"string",
            "description":" Indicates whether a registered user can delegate view-only access for all transactions for an account profile. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "RequestDelegateProjMgr":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether registered users who are the primary contact for a project can request delegation. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "SensitiveFlagOn":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether registered users can hide contact information from public view. If the value is Y, data for users who choose to hide contact information may require special handling. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowViewSpecificTrans":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a registered user can delegate view-only access for individual transactions. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowDeleteAttachments":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether registered public users can delete documents in account management.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowNumDelegates":{
            "type":"integer",
            "description":"Identifies the number of delegates allowed per profile. The limit is 999. ",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "AllowUpdSpecificTrans":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a registered user can delegate the ability to manage individual transactions. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowViewProfAttach":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a user with delegated access to all transactions in a profile can also view attachments for the profile. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that customers can modify.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "AllowAttachments":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether users can attach documents in account management. If the value is Y, users can attach documents. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowUpdAllTrans":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a registered user can delegate the ability to manage all transactions for an account profile. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "InvitationExpiryOpt":{
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the unit of time for the delegation invitation expiration period. The options are Days, Weeks, or Months.",
            "nullable":true,
            "x-queryable":true
        },
        "InviteExpiryNum":{
            "type":"integer",
            "description":"Identifies the number of days, weeks or months for the delegation invitation expiration period. This attribute is just for the number. Use the Invitation Expiry Option attribute to define the type of time period.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "UserTermsOfUseId":{
            "title":"Terms of Use ID",
            "maxLength":"15",
            "type":"string",
            "description":"Identifier for the terms of use, if any, that the user needs to accept during registration.",
            "nullable":true,
            "x-queryable":true
        },
        "SensitiveFlagAll":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether an agency can hide contact information for all applicants from public view. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "AllowIvrAccess":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a registered user can enter a code into an interactive voice response system to access permit records and maintain inspection schedules The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the record is logically deleted. If the value is Y, the record has been logically deleted. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "DocGroupId":{
            "title":"Document Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the attachment document group.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowDelegation":{
            "maxLength":"1",
            "type":"string",
            "description":"When this option is enabled, registered users can delegate transactions to other users. Delegation can be for all transactions for a profile or for individual transactions. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the meaning that is associated with the Invitation Expiry Option lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowViewProfLicense":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a user with delegated access to all transactions in a profile can also view licenses for the profile. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowTextCommunication":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a registered user can choose to receive communications as text messages. The default value is N.",
            "nullable":false,
            "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