Create a user's reference data
post
/fscmRestApi/resources/11.13.18.05/publicSectorUserRefs
Request
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
Root Schema : schema
Type:
Show Source
object
-
Address1: string
First line of the registered user's address.
-
Address2: string
Second line of the registered user's address.
-
Address3: string
Third line of the registered user's address.
-
Address4: string
Fourth line of the registered user's address.
-
BusinessName: string
Business name for the registered user's business profile.
-
City: string
City for the registered user's address.
-
Country: string
Country for the registered user's address.
-
County: string
County for the registered user's address.
-
CreateUser: string
Indicates whether a registered user profile needs to be created.
-
DefaultProfile: integer
(int64)
The registered user's profile that is used by default when the user signs in.
-
FirstName: string
First name of the registered user.
-
IvrAccessCode: string
The user's four digit code to access permit records and maintain inspection schedules using an interactive voice response system.
-
JobTitle: string
The business title of the registered user.
-
LastName: string
Last name of the registered user.
-
PartyId: integer
(int64)
Party ID for the registered user.
-
PhoneAreaCode: string
Phone area code for the registered user.
-
PhoneCountryCode: string
Phone country code for the registered user.
-
PhoneExtension: string
Phone extension for the registered user.
-
PhoneNumber: string
Phone number for the registered user.
-
PostalCode: string
Postal code of the registered user address.
-
PostalPlus4Code: string
Four digit extension to the postal code.
-
PreferredContactMethod: string
Preferred contact method for the registered user.
-
Province: string
Province for the address for the registered user.
-
PscUserId: integer
Unique identifier for the registered user reference row.
-
Salutation: string
Salutation for the registered user.
-
SensitiveFlag: string
Indicates whether the registered user's contact information should be hidden from public view.
-
State: string
State for the registered user address.
-
TermsUseAcceptDate: string
(date)
Date when the registered user accepted the terms of use.
-
TermsUseAcceptedBy: string
Maximum Length:
64
User who accepted the terms of use. -
TermsUseId: string
Maximum Length:
15
Terms of use ID accepted by the user. -
TermsUsePersonType: string
Maximum Length:
10
Indicates whether the terms of use were accepted by the registered user or by agency staff on behalf of the registered user. -
UserEmailId: string
Email address of the registered user.
-
UserName: string
User name of the registered user.
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 : publicSectorUserRefs-item-response
Type:
Show Source
object
-
Address1: string
First line of the registered user's address.
-
Address2: string
Second line of the registered user's address.
-
Address3: string
Third line of the registered user's address.
-
Address4: string
Fourth line of the registered user's address.
-
BusinessName: string
Business name for the registered user's business profile.
-
City: string
City for the registered user's address.
-
Country: string
Country for the registered user's address.
-
County: string
County for the registered user's address.
-
CreateUser: string
Indicates whether a registered user profile needs to be created.
-
DefaultProfile: integer
(int64)
The registered user's profile that is used by default when the user signs in.
-
FirstName: string
First name of the registered user.
-
IvrAccessCode: string
The user's four digit code to access permit records and maintain inspection schedules using an interactive voice response system.
-
JobTitle: string
The business title of the registered user.
-
LastName: string
Last name of the registered user.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Party ID for the registered user.
-
PhoneAreaCode: string
Phone area code for the registered user.
-
PhoneCountryCode: string
Phone country code for the registered user.
-
PhoneExtension: string
Phone extension for the registered user.
-
PhoneNumber: string
Phone number for the registered user.
-
PostalCode: string
Postal code of the registered user address.
-
PostalPlus4Code: string
Four digit extension to the postal code.
-
PreferredContactMethod: string
Preferred contact method for the registered user.
-
Province: string
Province for the address for the registered user.
-
PscUserId: integer
Unique identifier for the registered user reference row.
-
Salutation: string
Salutation for the registered user.
-
SensitiveFlag: string
Indicates whether the registered user's contact information should be hidden from public view.
-
State: string
State for the registered user address.
-
TermsUseAcceptDate: string
(date)
Date when the registered user accepted the terms of use.
-
TermsUseAcceptedBy: string
Maximum Length:
64
User who accepted the terms of use. -
TermsUseId: string
Maximum Length:
15
Terms of use ID accepted by the user. -
TermsUsePersonType: string
Maximum Length:
10
Indicates whether the terms of use were accepted by the registered user or by agency staff on behalf of the registered user. -
UserEmailId: string
Email address of the registered user.
-
UserName: string
User name of the registered user.
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.