Skip to end of banner
Go to start of banner

GET jobs/generic_purpose/get_requested_by_unit

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Available from CRM.COM R14.14.0

This method returns the Units through which a Job will be fulfilled. Multiple Units might be returned by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the account related to the job The allowed account identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

type_identifier
(semi-optional)

Job type identifier

The identifier of the job type that is requested by the customer. Only job types classified as Generic Purpose can be specified. The allowed job type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job type

name

(semi-optional)

String

The name of the job type

alternative_code

(semi-optional)

String

The alternative code of  the job type

receipt_method

(mandatory)

Receipt Method identifier

The identifier of the job's receipt method. Determines if the customer prefers the job physical goods to be send to him at the specified delivery address, to pick them up from a specific unit or in any other way. The supported options are the following:

  • DELIVERY
  • PICK_UP
  • OTHER

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

Examples

 Example 1

HTTP Method: GET


Request:

Response:
  • No labels