Create a contact type
post
/fscmRestApi/resources/11.13.18.05/publicSectorContactTypes
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
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the contact type. -
BlAccess: string
Title:
Business and License Access
Maximum Length:30
Default Value:ORA_CONTACT_ACCESS_NONE
The contact type access for business license application. -
ContactType: string
Title:
Contact Type Code
Maximum Length:30
The contact type name. -
ContactTypeName: string
Title:
Contact Type
Maximum Length:50
The short description of the contact type. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the record is logically deleted. Valid values are Y for a deleted record and N for an active record. The default value is N. -
Description: string
Title:
Description
Maximum Length:100
The description of the contact type. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the contact type is active. If the value is Y, the contact type is active. -
PermitAccess: string
Title:
Permit Access
Maximum Length:30
Default Value:ORA_CONTACT_ACCESS_NONE
The contact type access for permit application. -
PlanningAccess: string
Title:
Planning Access
Maximum Length:30
Default Value:ORA_CONTACT_ACCESS_NONE
The contact type access for planning application. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that can't be modified, and 2 for seed data that can be modified.
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 : publicSectorContactTypes-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the contact type. -
BlAccess: string
Title:
Business and License Access
Maximum Length:30
Default Value:ORA_CONTACT_ACCESS_NONE
The contact type access for business license application. -
ContactType: string
Title:
Contact Type Code
Maximum Length:30
The contact type name. -
ContactTypeName: string
Title:
Contact Type
Maximum Length:50
The short description of the contact type. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the contact type was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the record is logically deleted. Valid values are Y for a deleted record and N for an active record. The default value is N. -
Description: string
Title:
Description
Maximum Length:100
The description of the contact type. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the contact type is active. If the value is Y, the contact type is active. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the contact type was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PermitAccess: string
Title:
Permit Access
Maximum Length:30
Default Value:ORA_CONTACT_ACCESS_NONE
The contact type access for permit application. -
PlanningAccess: string
Title:
Planning Access
Maximum Length:30
Default Value:ORA_CONTACT_ACCESS_NONE
The contact type access for planning application. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that can't be modified, and 2 for seed data that can be modified.
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.