Versions Compared

Old Version 1

changes.mady.by.user Joseph Ioannou

Saved on

compared with

New Version Current

changes.mady.by.user Christina Georgiou

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R14.0.0

Excerpt

This method returns information related to the latest jobs of fulfillment scope Swap Subscription Services. Multiple jobs are returned by each call. Results are sorted based on the date that they were updated in a descending order

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the account related to the job that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(semi-optional)

Job Type Identifier

The identifier of the job type related with the jobs that should be returned as a result. Only job types classified as Swap Subscription Services can be specified. The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise, the results will begin at the provided offset number

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

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "data": [
        {
            "notes": null,
            "contact_phone": null,
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2016-03-24T11:26:17",
                "updated_date": "2016-03-24T12:57:53",
                "updated_by_user": {
                    "person_name": "Persy Xe",
                    "id": "E59E9C8A474D45C687D37047EF230FAC",
                    "email": "p_xenopoulou@crm.com",
                    "username": "pxenopoulou"
                },
                "created_by_user": {
                    "person_name": "Persy Xe",
                    "id": "E59E9C8A474D45C687D37047EF230FAC",
                    "email": "p_xenopoulou@crm.com",
                    "username": "pxenopoulou"
                }
            },
            "requested_physical_goods_set": [
                {
                    "product": {
                        "code": "Cables",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": false,
                            "alternative_code": "SP",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Spare Parts",
                            "description": "Spare Parts",
                            "id": "23C3916E974A461B97BBF650546645F7",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "NONTRACEABLE"
                        },
                        "alternative_code": "C_2",
                        "description": "Cables",
                        "id": "A21B1D394871493E8BC40ECF3DD2D579",
                        "priority_level": null
                    },
                    "quantity": 1,
                    "notes": null,
                    "id": "BE4528AFF3FD4D2BBBE7304F8BBAC478"
                }
            ],
            "expiration_date": null,
            "type": {
                "billing_method": null,
                "alternative_code": "SSS",
                "name": "Swap Sub Services",
                "fulfillment_scope": "SWAP_SUBSCRIPTION_SERVICES",
                "description": null,
                "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
                "id": "116CD2F010124244929281101F7D40DE",
                "billing_directive": "BILLABLE"
            },
            "scheduled_date": null,
            "number": "J00000132",
            "bills_set": null,
            "id": "99AE55F2352B4B6E997A5BC656133203",
            "actual_completed_date": null,
            "requested_expenses_set": [
                {
                    "product": {
                        "code": "Expense 1",
                        "product_type": {
                            "service_type": "EXPENSE",
                            "used_for_provisioning": false,
                            "alternative_code": "006",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Fees",
                            "description": "Fees One Time Services",
                            "id": "6",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "E1",
                        "description": "Expense 1",
                        "id": "A9917A7895044BEF9499DD6958539D33",
                        "priority_level": null
                    },
                    "id": "4B75B9ADE65F4C2A9A83B0FBD10CD529"
                }
            ],
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "privacy_level": null,
            "udf_string_1": "1",
            "life_cycle_state": "IN_PROGRESS",
            "subscription_services_set": [
                {
                    "product": {
                        "code": "Movies 1",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "AS",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Additional Services",
                            "description": null,
                            "id": "C8321F0BCA8A4051857BC35CEEE41555",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "M1",
                        "description": "Movies 1",
                        "id": "571C10876AF840088372A94A14D0A02C",
                        "priority_level": null
                    },
                    "first_activated_date": "2016-03-24T09:39:59",
                    "rating_state": "PENDING",
                    "service_bundle": null,
                    "rated_up_to_date": "2016-09-28T00:00:00",
                    "id": "EC3E0F304F6D4DFABC03E2100D4DB7F7",
                    "life_cycle_state": "NOT_EFFECTIVE"
                },
                {
                    "product": {
                        "code": "Bronze",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "Main Packages",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Main Packages",
                            "description": null,
                            "id": "E186E293AAAB49EE86A729540A4287FE",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "B",
                        "description": "Bronze",
                        "id": "F50CC52934BD4F119B6E18E215A4FC55",
                        "priority_level": null
                    },
                    "first_activated_date": "2016-03-24T09:39:59",
                    "rating_state": "PENDING",
                    "service_bundle": null,
                    "rated_up_to_date": "2016-09-28T00:00:00",
                    "id": "6951D73AC3F6480CBF1D43BAA14CF295",
                    "life_cycle_state": "NOT_EFFECTIVE"
                }
            ],
            "activities_set": [
                {
                    "number": "88",
                    "contact_information": {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Matt Murdock",
                        "last_name": "Murdock",
                        "id": "73CD30EDBBD0405299D9E780431D640D",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Matt",
                        "demographics": {
                            "name_day": {
                                "month": null,
                                "day": null
                            },
                            "id_number": "12113213",
                            "gender": null,
                            "country_of_residence": {
                                "alternative_code": "IRN",
                                "three_character_code": null,
                                "name": "IRAN (ISLAMIC REPUBLIC OF)",
                                "id": "231",
                                "two_character_code": null
                            },
                            "date_of_birth": {
                                "month": null,
                                "year": null,
                                "day": null
                            },
                            "industry_sector": null,
                            "passport_number": "d213213",
                            "industry": null,
                            "social_security_number": null,
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    },
                    "id": "65CE802AD1C44324B9BEA6BCB57F6E67",
                    "life_cycle_state": "COMPLETED",
                    "type": {
                        "alternative_code": "I",
                        "name": "Installation",
                        "description": "test",
                        "id": "47675EE2507BC9237F144B46221F7B17"
                    }
                }
            ],
            "physical_goods_set": [
                {
                    "installed_item": null,
                    "product": {
                        "code": "Cables",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": false,
                            "alternative_code": "SP",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Spare Parts",
                            "description": "Spare Parts",
                            "id": "23C3916E974A461B97BBF650546645F7",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "NONTRACEABLE"
                        },
                        "alternative_code": "C_2",
                        "description": "Cables",
                        "id": "A21B1D394871493E8BC40ECF3DD2D579",
                        "priority_level": null
                    },
                    "quantity": 1,
                    "id": "62F15BD37B1448E7AA7E8C55AF86D1D4"
                }
            ],
            "time_overdue": {
                "time_period_uot": "YEARS",
                "time_period_value": 1.4863387978142077
            },
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "status": {
                "alternative_code": "2",
                "name": "Approved",
                "description": null,
                "id": "7A98FA9566534F1C82227985EA48F617",
                "life_cycle_state": "IN_PROGRESS"
            },
            "owned_by_group": {
                "alternative_code": "MG",
                "community_name": "Community",
                "name": "Main Group",
                "description": "Main Group",
                "id": "1"
            },
            "description": null,
            "rating_state": "PENDING",
            "expenses_set": [
                {
                    "product": {
                        "code": "Expense 1",
                        "product_type": {
                            "service_type": "EXPENSE",
                            "used_for_provisioning": false,
                            "alternative_code": "006",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Fees",
                            "description": "Fees One Time Services",
                            "id": "6",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "E1",
                        "description": "Expense 1",
                        "id": "A9917A7895044BEF9499DD6958539D33",
                        "priority_level": null
                    },
                    "id": "6D9D55D906AA41999480DFADD18A5CE3"
                }
            ],
            "subscription": {
                "number": "S0000000149",
                "first_activated_date": "2016-03-24T09:39:59",
                "rating_state": "PENDING",
                "accounts_receivable": {
                    "number": "ACR0000000146",
                    "name": "ACR0000000146 Matt Murdock",
                    "id": "3C069940B0B74A039894143087B1D345",
                    "life_cycle_state": "ACTIVE",
                    "account_owner": {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Matt Murdock",
                        "last_name": "Murdock",
                        "id": "73CD30EDBBD0405299D9E780431D640D",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Matt",
                        "demographics": {
                            "name_day": {
                                "month": null,
                                "day": null
                            },
                            "id_number": "12113213",
                            "gender": null,
                            "country_of_residence": {
                                "alternative_code": "IRN",
                                "three_character_code": null,
                                "name": "IRAN (ISLAMIC REPUBLIC OF)",
                                "id": "231",
                                "two_character_code": null
                            },
                            "date_of_birth": {
                                "month": null,
                                "year": null,
                                "day": null
                            },
                            "industry_sector": null,
                            "passport_number": "d213213",
                            "industry": null,
                            "social_security_number": null,
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    }
                },
                "id": "B4E56053678A4CC68FDC38B25E34A5A2",
                "life_cycle_state": "NOT_EFFECTIVE",
                "type": {
                    "alternative_code": "normalsub",
                    "name": "Normal",
                    "description": null,
                    "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
                }
            },
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "contact_email": null,
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "requested_subscription_services_set": [
                {
                    "product": {
                        "code": "Movies 1",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "AS",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Additional Services",
                            "description": null,
                            "id": "C8321F0BCA8A4051857BC35CEEE41555",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "M1",
                        "description": "Movies 1",
                        "id": "571C10876AF840088372A94A14D0A02C",
                        "priority_level": null
                    },
                    "provisioning_distributor": null,
                    "id": "35654C4C85F94002B0800340D227272A",
                    "swap_product": {
                        "code": "MTV",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "AS",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Additional Services",
                            "description": null,
                            "id": "C8321F0BCA8A4051857BC35CEEE41555",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "M_1",
                        "description": "MTV",
                        "id": "937C439D5C4F48588FC75D0F832DD62F",
                        "priority_level": null
                    },
                    "product_bundle": null
                },
                {
                    "product": {
                        "code": "Bronze",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "Main Packages",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Main Packages",
                            "description": null,
                            "id": "E186E293AAAB49EE86A729540A4287FE",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "B",
                        "description": "Bronze",
                        "id": "F50CC52934BD4F119B6E18E215A4FC55",
                        "priority_level": null
                    },
                    "provisioning_distributor": null,
                    "id": "C14FC3EA35EC4DF8AD8B6749F39533FE",
                    "swap_product": {
                        "code": "Gold",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "Main Packages",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Main Packages",
                            "description": null,
                            "id": "E186E293AAAB49EE86A729540A4287FE",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "G",
                        "description": "Gold",
                        "id": "D1EB074DFD904E54A0C67CAB9DC7E010",
                        "priority_level": null
                    },
                    "product_bundle": null
                }
            ],
            "estimated_completion_time": {
                "time_period_uot": "DAYS",
                "time_period_value": 1
            },
            "service_request": null,
            "udf_float_1": null,
            "billing_terms": null,
            "udf_float_2": null,
            "start_date": "2016-03-24T11:26:17",
            "assigned_to": {
                "unit": {
                    "alternative_code": "UA",
                    "group_name": "GroupA",
                    "community_name": "CommunityA",
                    "name": "Unit A",
                    "description": null,
                    "id": "72CD6EBE88E541CA879BBA9ECBA11E68"
                },
                "user": {
                    "person_name": "Persy Xe",
                    "id": "E59E9C8A474D45C687D37047EF230FAC",
                    "email": "p_xenopoulou@crm.com",
                    "username": "pxenopoulou"
                }
            },
            "accounts_receivable": {
                "number": "ACR0000000146",
                "name": "ACR0000000146 Matt Murdock",
                "id": "3C069940B0B74A039894143087B1D345",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": "Matt Murdock",
                    "last_name": "Murdock",
                    "id": "73CD30EDBBD0405299D9E780431D640D",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Matt",
                    "demographics": {
                        "name_day": {
                            "month": null,
                            "day": null
                        },
                        "id_number": "12113213",
                        "gender": null,
                        "country_of_residence": {
                            "alternative_code": "IRN",
                            "three_character_code": null,
                            "name": "IRAN (ISLAMIC REPUBLIC OF)",
                            "id": "231",
                            "two_character_code": null
                        },
                        "date_of_birth": {
                            "month": null,
                            "year": null,
                            "day": null
                        },
                        "industry_sector": null,
                        "passport_number": "d213213",
                        "industry": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "time_to_completion": {
                "time_period_uot": null,
                "time_period_value": null
            },
            "requested_activity_services_set": [
                {
                    "product": {
                        "code": "Installation Service",
                        "product_type": {
                            "service_type": "ONETIME",
                            "used_for_provisioning": false,
                            "alternative_code": "I",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Services",
                            "description": null,
                            "id": "7A2F73F07F944CBAB8C5ACDA1A7879B4",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "IS",
                        "description": "Installation Service",
                        "id": "DB4875A4EB7C46BF94AD72169B36FD90",
                        "priority_level": null
                    },
                    "activity_type": {
                        "alternative_code": "I",
                        "name": "Installation",
                        "description": "test",
                        "id": "47675EE2507BC9237F144B46221F7B17"
                    },
                    "id": "6717F2576C28412CB33EDDF134CF0F05"
                }
            ],
            "location": {
                "apartment_number": "121",
                "care_of": null,
                "country": {
                    "alternative_code": "USA",
                    "three_character_code": "USA",
                    "name": "UNITED STATES OF AMERICA",
                    "id": "127",
                    "two_character_code": "US"
                },
                "municipality": null,
                "type": "HOME",
                "udf_date_2": null,
                "udf_date_1": null,
                "street_name": "57th and 7th ",
                "udf_date_4": null,
                "udf_date_3": null,
                "udf_float_3": null,
                "udf_float_4": null,
                "po_box_postal_code": null,
                "udf_string_15": null,
                "udf_string_16": null,
                "udf_string_13": null,
                "udf_string_14": null,
                "udf_string_11": null,
                "udf_string_12": null,
                "id": "20BB61053142444EAF2740E07ECD9495",
                "state": "Active",
                "udf_string_10": null,
                "floor": 12,
                "udf_float_1": null,
                "udf_float_2": null,
                "area": "Hell's Kitchen",
                "udf_string_2": null,
                "udf_string_3": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_1": null,
                "po_box": null,
                "town_city": "New York",
                "district": null,
                "street_number": "4012",
                "postal_code": "1212",
                "udf_string_6": null,
                "udf_string_7": null,
                "udf_string_8": null,
                "udf_string_9": null
            },
            "category": null,
            "expected_completion_date": "2016-03-25T11:26:17"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}
Expand
titleExample 2

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "data": [
        {
            "number": "J00000577",
            "description": null,
            "id": "1452C57B750B495CB295B560AED406EF",
            "life_cycle_state": "PENDING"
        },
        {
            "number": "J00000576",
            "description": null,
            "id": "BD3D38FDA2F7425CA4442017C1ECDE52",
            "life_cycle_state": "PENDING"
        },
        {
            "number": "J00000284",
            "description": null,
            "id": "B3DA13198A564D51B08E6BD95A65CCDB",
            "life_cycle_state": "PENDING"
        },
        {
            "number": "J00000137",
            "description": null,
            "id": "15B18E3AC6674E2890559BFCA11205B5",
            "life_cycle_state": "COMPLETED"
        },
        {
            "number": "J00000132",
            "description": null,
            "id": "99AE55F2352B4B6E997A5BC656133203",
            "life_cycle_state": "IN_PROGRESS"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}