Create an agency address
post
/fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses
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
Title:
Address
Maximum Length:240
The first address line of the agency address. -
Address2: string
Title:
Address
Maximum Length:240
The second address line of the agency address. -
Address3: string
Title:
Address
Maximum Length:240
The third address line of the agency address. -
Address4: string
Title:
Address
Maximum Length:240
The fourth address line of the agency address. -
AddressCode: string
Title:
Address ID
Maximum Length:32
The unique identifier of the address. Value is mandatory and is entered by the user when the address is created. -
AgencyAddressId: integer
Title:
Address ID
The unique identifier of the address. Value is mandatory and is system-generated when the address is created. ID is not displayed to the user. -
AgencyId: integer
(int32)
Title:
Agency ID
The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1. -
CityName: string
Title:
City
Maximum Length:60
The name of the city as part of the agency address. -
CountryCode: string
Title:
Country
Maximum Length:3
The name of the country as part of the agency address. -
CountyCodeIncits: string
Title:
County
Maximum Length:60
The name of the county as part of the agency address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal code plus four as part of the agency address. -
PrimaryFlag: string
Title:
Primary
Maximum Length:1
Indicates whether the address is the primary address of the agency. A value of Y means the address is primary. Default value is N. -
Province: string
Title:
Province
Maximum Length:60
The name of the province as part of the agency address. -
State: string
Title:
State
Maximum Length:60
The name of the state as part of the agency address. -
ValidFromDate: string
(date)
Title:
From Date
The first day that the address may be used. -
ValidToDate: string
(date)
Title:
To Date
The last day that the address may be used. -
ZipCode: string
Title:
Postal Code
Maximum Length:60
The postal code as part of the agency address.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorAgencyAddresses-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address
Maximum Length:240
The first address line of the agency address. -
Address2: string
Title:
Address
Maximum Length:240
The second address line of the agency address. -
Address3: string
Title:
Address
Maximum Length:240
The third address line of the agency address. -
Address4: string
Title:
Address
Maximum Length:240
The fourth address line of the agency address. -
AddressCode: string
Title:
Address ID
Maximum Length:32
The unique identifier of the address. Value is mandatory and is entered by the user when the address is created. -
AgencyAddressId: integer
Title:
Address ID
The unique identifier of the address. Value is mandatory and is system-generated when the address is created. ID is not displayed to the user. -
AgencyId: integer
(int32)
Title:
Agency ID
The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1. -
CityName: string
Title:
City
Maximum Length:60
The name of the city as part of the agency address. -
CountryCode: string
Title:
Country
Maximum Length:3
The name of the country as part of the agency address. -
CountyCodeIncits: string
Title:
County
Maximum Length:60
The name of the county as part of the agency address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the agency address. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the agency addess was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The last date and time that the agency address was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the agency address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal code plus four as part of the agency address. -
PrimaryFlag: string
Title:
Primary
Maximum Length:1
Indicates whether the address is the primary address of the agency. A value of Y means the address is primary. Default value is N. -
Province: string
Title:
Province
Maximum Length:60
The name of the province as part of the agency address. -
State: string
Title:
State
Maximum Length:60
The name of the state as part of the agency address. -
ValidFromDate: string
(date)
Title:
From Date
The first day that the address may be used. -
ValidToDate: string
(date)
Title:
To Date
The last day that the address may be used. -
ZipCode: string
Title:
Postal Code
Maximum Length:60
The postal code as part of the agency address.
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.