{"docs":{"name":"TrackDrive","info":"\n\u003cp\u003eTrackdrive API Reference\u003c/p\u003e\n","copyright":null,"doc_url":"/api/docs/1.0","api_url":"/api","resources":[{"doc_url":"/api/docs/1.0/sip_headers","id":"sip_headers","api_url":"/api","name":"SIP Header","short_description":"Custom SIP headers attached to a buyer, sent on the SIP leg of a call placed to that buyer.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sip_headers/index","name":"index","apis":[{"api_url":"/api/v1/sip_headers","http_method":"GET","short_description":"List Sip Header records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_headers/new","name":"new","apis":[{"api_url":"/api/v1/sip_headers/new","http_method":"GET","short_description":"Build Sip Header with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a 128-bit UUID reference to an object on Trackdrive, such as 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eBuyer\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_headers/create","name":"create","apis":[{"api_url":"/api/v1/sip_headers","http_method":"POST","short_description":"Create Sip Header.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a 128-bit UUID reference to an object on Trackdrive, such as 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eBuyer\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_headers/show","name":"show","apis":[{"api_url":"/api/v1/sip_headers/:id","http_method":"GET","short_description":"Get Sip Header by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_headers/update","name":"update","apis":[{"api_url":"/api/v1/sip_headers/:id","http_method":"PUT","short_description":"Update Sip Header by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a 128-bit UUID reference to an object on Trackdrive, such as 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eBuyer\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_headers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sip_headers/:id","http_method":"DELETE","short_description":"Destroy Sip Header by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}]}}