Jump to

• Request
• Response

Create an address

post

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/addresses

Request

Path Parameters

• SrNumber(required): string
  The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first address line of the service address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second address line of the service address.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address line of the service address.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address line of the service address.
• AddressSourceCd: string
  Title: Address Source Code

  Maximum Length: 30

  Indicates the source of the service address of the service request. For example, the address source can be account or contact.
• City: string
  Title: City

  Maximum Length: 60

  The city of the service address.
• Country: string
  Title: Country

  Maximum Length: 2

  The country of the service address.
• County: string
  Title: County

  Maximum Length: 60

  The county of the service address.
• LocationId: integer (int64)
  Title: Location ID

  The location that was the source of the service address.
• PartySiteId: integer (int64)
  Title: Party Site ID

  The customer address that was the source of the service address.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the service address.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the service address.
• ServiceAddressId: integer (int64)
  Title: Service Address ID

  The unique identifier of the service address record.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request associated to the service address.
• State: string
  Title: State

  Maximum Length: 60

  The state of the service address.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 50

  The time zone of the service address.

{
    "type":"object",
    "properties":{
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first address line of the service address.",
            "nullable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address line of the service address.",
            "nullable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address line of the service address.",
            "nullable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line of the service address.",
            "nullable":true
        },
        "AddressSourceCd":{
            "title":"Address Source Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the source of the service address of the service request. For example, the address source can be account or contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the service address.",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country of the service address.",
            "nullable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the service address.",
            "nullable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The location that was the source of the service address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"integer",
            "description":"The customer address that was the source of the service address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the service address.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the service address.",
            "nullable":true
        },
        "ServiceAddressId":{
            "title":"Service Address ID",
            "type":"integer",
            "description":"The unique identifier of the service address record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request associated to the service address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the service address.",
            "nullable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":50,
            "type":"string",
            "description":"The time zone of the service address.",
            "nullable":true
        }
    }
}

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 : serviceRequests-addresses-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first address line of the service address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second address line of the service address.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address line of the service address.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address line of the service address.
• AddressSourceCd: string
  Title: Address Source Code

  Maximum Length: 30

  Indicates the source of the service address of the service request. For example, the address source can be account or contact.
• City: string
  Title: City

  Maximum Length: 60

  The city of the service address.
• Country: string
  Title: Country

  Maximum Length: 2

  The country of the service address.
• County: string
  Title: County

  Maximum Length: 60

  The county of the service address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the service address.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the service address was created.
• FormattedAddress: string
  Title: Formatted Address

  Read Only: true

  Maximum Length: 1000

  The formatted address value of the service address.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the service address was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the service address.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the service address.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  Title: Location ID

  The location that was the source of the service address.
• PartySiteId: integer (int64)
  Title: Party Site ID

  The customer address that was the source of the service address.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the service address.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the service address.
• ServiceAddressId: integer (int64)
  Title: Service Address ID

  The unique identifier of the service address record.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request associated to the service address.
• State: string
  Title: State

  Maximum Length: 60

  The state of the service address.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 50

  The time zone of the service address.

{
    "type":"object",
    "properties":{
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first address line of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address line of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address line of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressSourceCd":{
            "title":"Address Source Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the source of the service address of the service request. For example, the address source can be account or contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the service address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the service address was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Formatted Address",
            "maxLength":1000,
            "type":"string",
            "description":"The formatted address value of the service address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the service address was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the service address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The location that was the source of the service address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"integer",
            "description":"The customer address that was the source of the service address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceAddressId":{
            "title":"Service Address ID",
            "type":"integer",
            "description":"The unique identifier of the service address record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request associated to the service address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":50,
            "type":"string",
            "description":"The time zone of the service address.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Links

AddressSourceCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_ADDRESS_SOURCE_CD

The list of values indicating the service address source.

Back to Top